Adding doxygen template to all core .c files

Please fill in after the :: to explain the function of this file.
hanqi001 · Oct 10, 2009 · 1d0661d · 1d0661d
1 parent 7eb41a8
commit 1d0661d
Show file tree

Hide file tree

Showing 70 changed files with 494 additions and 4 deletions.
diff --git a/action.c b/action.c
@@ -52,6 +52,13 @@
  *  2009-05-04  switched IF_T to rval_expr (andrei)
  *  2009-09-15  added SET_{FWD,RPL}_NO_CONNECT, SET_{FWD,RPL}_CLOSE (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include "comp_defs.h"

diff --git a/atomic_ops.c b/atomic_ops.c
@@ -24,6 +24,13 @@
  *  2006-03-08  created by andrei
  *  2007-05-11  added lock_set support (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "atomic_ops_init.h"
 #include "atomic_ops.h"

diff --git a/basex.c b/basex.c
@@ -26,6 +26,13 @@
  * --------
  *  2008-06-11  created by andrei
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "basex.h"
 

diff --git a/bit_scan.c b/bit_scan.c
@@ -23,6 +23,13 @@
  * --------
  *  2007-06-23  created by andrei
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "bit_scan.h"
 

diff --git a/cfg_core.c b/cfg_core.c
@@ -29,6 +29,13 @@
  *  2007-12-03	Initial version (Miklos)
  *  2008-01-31  added DNS resolver parameters (Miklos)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "dprint.h"
 #ifdef USE_DST_BLACKLIST

diff --git a/cfg_parser.c b/cfg_parser.c
@@ -21,6 +21,13 @@
  * with this program; if not, write to the Free Software Foundation, Inc., 
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 /** Example 1: Options without values
  *

diff --git a/core_cmd.c b/core_cmd.c
@@ -24,6 +24,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <time.h>
 #include <sys/types.h>

diff --git a/crc.c b/crc.c
@@ -26,6 +26,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include <stdio.h>

diff --git a/daemonize.c b/daemonize.c
@@ -35,6 +35,13 @@
  *  2007-06-07  added mlock_pages (no swap) support (andrei)
   *             added set_rt_prio() (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include <sys/types.h>

diff --git a/data_lump.c b/data_lump.c
@@ -34,6 +34,13 @@
  *  2003-10-28  added extra checks (paranoia) for {anchor,del}_lump (andrei)
  *  2005-03-24  the type of type attribute changed to enum _hdr_types_t (janakj)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include "data_lump.h"

diff --git a/data_lump_rpl.c b/data_lump_rpl.c
@@ -34,6 +34,13 @@
  *               returns a lump_rpl**, making a specific lump removal much
  *               more easy (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include <string.h>

diff --git a/dns_cache.c b/dns_cache.c
@@ -48,6 +48,13 @@
  *  2009-03-30  EBL record support (andrei)
  *  2009-04-01  PTR record support (andrei)
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #ifdef USE_DNS_CACHE
 

diff --git a/dprint.c b/dprint.c
@@ -27,6 +27,13 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include "globals.h"

diff --git a/dset.c b/dset.c
@@ -27,6 +27,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <string.h>
 #include "dprint.h"
 #include "config.h"

diff --git a/dst_blacklist.c b/dst_blacklist.c
@@ -37,6 +37,13 @@
  *  2009-02-26  added dst_blacklist_su* variant (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #ifdef USE_DST_BLACKLIST
 

diff --git a/endianness.c b/endianness.c
@@ -23,6 +23,13 @@
  *  2008-06-13  created by andrei
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "endianness.h"
 
 int _endian_test_int=1 /* used for the runtime endian tests */;

diff --git a/error.c b/error.c
@@ -30,6 +30,13 @@
  * 2003-04-04 phrase length corrected not to include trailer 0 (jiri)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <stdio.h>
 #include "error.h"

diff --git a/events.c b/events.c
@@ -18,6 +18,13 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "dprint.h"
 #include "mem/mem.h"
 #include "events.h"

diff --git a/flags.c b/flags.c
@@ -31,6 +31,13 @@
  *  2006-02-02  named flags support (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <limits.h>
 #include "sr_module.h"

diff --git a/forward.c b/forward.c
@@ -56,6 +56,13 @@
  *               socket is multicast (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include <string.h>

diff --git a/hash_func.c b/hash_func.c
@@ -25,6 +25,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #ifndef _CRC_H_

diff --git a/id.c b/id.c
@@ -25,6 +25,13 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "id.h"
 #include "parser/parse_from.h"
 #include "parser/parse_uri.h"

diff --git a/io_wait.c b/io_wait.c
@@ -27,6 +27,13 @@
  *  2005-07-04  added /dev/poll (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #ifndef NO_IO_WAIT

diff --git a/ip_addr.c b/ip_addr.c
@@ -34,6 +34,13 @@
  *  2004-10-01  mk_net fixes bad network addresses now (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <stdlib.h>
 #include <stdio.h>

diff --git a/local_timer.c b/local_timer.c
@@ -34,6 +34,13 @@
  *  2006-02-03  created by andrei
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "timer.h"
 #include "timer_funcs.h"

diff --git a/lock_ops.c b/lock_ops.c
@@ -24,6 +24,14 @@
  *  2007-05-14  created by andrei
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
+
 #include "ut.h"
 #include "dprint.h"
 #include "lock_ops.h"

diff --git a/lvalue.c b/lvalue.c
@@ -29,6 +29,13 @@
  *              delete the lvalue (similar to perl)  (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "lvalue.h"
 #include "dprint.h"
 #include "route.h"

diff --git a/main.c b/main.c
@@ -80,6 +80,20 @@
  *                (e.g. -l (eth0, 1.2.3.4, foo.bar) ) (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
+/*! \defgroup core SIP-router core
+ *
+ * This modules implements a SIP server with a module interface
+ * for extendability.
+ *
+ */
+
 
 #include <stdio.h>
 #include <stdlib.h>