Change description for insp_aton since only a positive return means convertion was...

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@6169 e03df62e-2008-0410-955e-edbf42e46eb7

diff --git a/include/socket.h b/include/socket.h
index b8f6387d329c6f691ce7d35f4de32d49e193f93b..cf2b9bf5bcab1a680d5af5b1a7704b1db2245965 100644 (file)
--- a/include/socket.h
+++ b/include/socket.h
@@ -111,7 +111,12 @@ namespace irc
                 * @param a A human-readable address
                 * @param n An insp_inaddr struct which the result
                 * will be copied into on success.
-                * @return This function will return 0 upon success,
+                * @return This method will return a negative value if address
+                * does not contain a valid address family. 0 if the address is
+                * does not contain a valid string representing a valid network
+                * address. A positive value is returned if the network address
+                * was successfully converted.
+
                 * or any other number upon failure.
                 */
                int insp_aton(const char* a, insp_inaddr* n);