From: Michael Jerris <mike@jerris.com>
Date: Fri, 19 Jan 2007 22:47:51 +0000 (+0000)
Subject: doxygen
X-Git-Tag: v1.0-beta1~1325
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=465456e3ee10f9bae88d41df00da99f6ce5985eb;p=thirdparty%2Ffreeswitch.git

doxygen

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@4006 d0543943-73ff-0310-b7d9-9358b9ac24b2
---

diff --git a/src/include/switch_utils.h b/src/include/switch_utils.h
index 8ef19bea70..d359fdbdc4 100644
--- a/src/include/switch_utils.h
+++ b/src/include/switch_utils.h
@@ -79,7 +79,13 @@ SWITCH_DECLARE(apr_status_t) switch_socket_recvfrom(apr_sockaddr_t *from, apr_so
 !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)