commit 7e14816e85660929f430f1d34792ee63aefb83ac
author Alexander Afanasyev <alexander.afanasyev@ucla.edu> Mon Dec 15 12:05:37 2014 -0800
committer Junxiao Shi <sunnylandh@gmail.com> Mon Dec 15 17:49:06 2014 -0800
tree 07ca73dd72e8348fd79fd23e61150bd533480dcd
parent 49e11e797e4b50d212e79fa8bf406d994a6cbb6c

core: Add a warning comment for listNetworkInterfaces() function

Change-Id: I2d0edaa4fced667cd79d8f7170c4a2968abd0390
Refs: #2292

core/network-interface.hpp

diff --git a/core/network-interface.hpp b/core/network-interface.hpp
index e9be083..0034052 100644
--- a/core/network-interface.hpp
+++ b/core/network-interface.hpp
@@ -89,6 +89,7 @@
 }
 
 /** \brief List configured network interfaces on the system and their info
+ *  \warning invalid IP addresses (e.g., 0.0.0.0) may be returned in some environments
  */
 std::vector<NetworkInterfaceInfo>
 listNetworkInterfaces();