[Freeswitch-svn] [commit] r4006 - freeswitch/trunk/src/include

[Freeswitch SVN]

Author: mikej
Date: Fri Jan 19 17:47:51 2007
New Revision: 4006

Modified:
   freeswitch/trunk/src/include/switch_utils.h

Log:
doxygen

Modified: freeswitch/trunk/src/include/switch_utils.h
==============================================================================
--- freeswitch/trunk/src/include/switch_utils.h	(original)
+++ freeswitch/trunk/src/include/switch_utils.h	Fri Jan 19 17:47:51 2007
@@ -79,7 +79,13 @@
 !strcasecmp(expr, "true") ||\
 atoi(expr))) ? SWITCH_TRUE : SWITCH_FALSE
 
-
+/*!
+  \brief find local ip of the box
+  \param buf the buffer to write the ip adress found into
+  \param len the length of the buf
+  \param family the address family to return (AF_INET or AF_INET6)
+  \return SWITCH_STATUS_SUCCESSS for success, otherwise failure
+*/
 SWITCH_DECLARE(switch_status_t) switch_find_local_ip(char *buf, int len, int family);
 
 #define SWITCH_STATUS_IS_BREAK(x) (x == SWITCH_STATUS_BREAK || x == 730035 || x == 35)