summaryrefslogtreecommitdiff
path: root/include/socket.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/socket.h')
-rw-r--r--include/socket.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/socket.h b/include/socket.h
index b8f6387d3..cf2b9bf5b 100644
--- 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);