Adding doxygen template to all core .c files

Please fill in after the :: to explain the function of this file.

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"

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"

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"
 

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"
 

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

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
  *

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>

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>

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>

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"

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>

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
 

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"

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"

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
 

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 */;

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"

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"

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"

forward.c

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

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_

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"

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

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>

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"

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"

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"

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>

md5.c

@@ -26,6 +26,13 @@ These notices must be retained in any copies of any part of this
 documentation and/or software.
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <string.h>
 #include "md5global.h"

md5utils.c

@@ -22,6 +22,13 @@ jku: added support to deal with vectors
 
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #define MD 5
 
 #include <stdio.h>

mod_fix.c

@@ -25,6 +25,13 @@
  *  2008-11-25  initial version (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "mod_fix.h"
 #include "mem/mem.h"
 

modparam.c

@@ -33,6 +33,13 @@
  * 2005-07-01  PARAM_STRING & PARAM_STR support
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "modparam.h"
 #include "dprint.h"

msg_translator.c

@@ -117,6 +117,13 @@
  *--andrei
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <netdb.h>

nonsip_hooks.c

@@ -35,6 +35,13 @@
  *  2006-11-29  created by andrei
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "nonsip_hooks.h"
 #include "mem/mem.h"
 

pass_fd.c

@@ -36,6 +36,13 @@
   *  2008-04-30  added MSG_WAITALL emulation for cygwin (andrei)
   */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #ifdef USE_TCP
 
 #include "pass_fd.h"

proxy.c

@@ -34,6 +34,13 @@
   *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
   */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include "config.h"

pt.c

@@ -38,6 +38,13 @@
  *  2007-07-04	added register_fds() and get_max_open_fds(() (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "pt.h"
 #include "tcp_init.h"

pv_core.c

@@ -22,6 +22,13 @@
  * absolutely necessary (use/create a new module instead).
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "pv_core.h"
 #include "pvar.h"
 #include "str.h"

pvapi.c

@@ -22,9 +22,12 @@
 
 /*!
  * \file
- * \brief PV API specification
+ * \brief SIP-router core ::  PV API specification
+ * \ingroup core
+ * Module: \ref core
  */
 
+
 #include <stdio.h>
 #include <string.h>
 #include <sys/types.h>

qvalue.c

@@ -31,6 +31,14 @@
  * 2004-04-25 created (janakj)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core ::  Handling of the q value
+ * \ingroup core
+ * Module: \ref core
+ */
+
+
 #include "error.h"
 #include "qvalue.h"
 

re.c

@@ -33,6 +33,13 @@
  *   2004-11-12  minor api extension, added *count (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core ::  regexp and regexp substitutions implementations
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include "dprint.h"
 #include "mem/mem.h"

receive.c

@@ -40,6 +40,13 @@
  * 2006-11-29 nonsip_msg hooks called for non-sip msg (e.g HTTP) (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <string.h>
 #include <stdlib.h>

resolve.c

@@ -49,6 +49,13 @@
  *  2009-04-01  PTR record support (andrei)
  */ 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <sys/types.h>
 #include <netinet/in.h>

route.c

@@ -53,6 +53,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <stdlib.h>
 #include <sys/types.h>
 #include <regex.h>

route_struct.c

@@ -36,6 +36,13 @@
  *  2005-12-19  select framework added SELECT_O and SELECT_ST (mma)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 
 #include  "route_struct.h"

rpc_lookup.c

@@ -24,6 +24,13 @@
  *  2009-05-11  initial version (andrei)
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "rpc.h"
 #include "str_hash.h"
 #include "ut.h"

rvalue.c

@@ -46,6 +46,13 @@
          expr == (type_of(expr))undef
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "rvalue.h"
 
 #include <stdlib.h> /* abort() */

script_cb.c

@@ -38,6 +38,13 @@
  *		of route blocks. (Miklos)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #include <stdlib.h>
 #include "script_cb.h"

sctp_options.c

@@ -25,6 +25,13 @@
  *  2009-05-26  runtime cfg support (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <string.h>
 #include <sys/types.h>
 #ifdef USE_SCTP

sctp_server.c

@@ -26,6 +26,13 @@
  *  2009-04-28  sctp stats & events macros (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #ifdef USE_SCTP
 
 #include <stdlib.h>

select.c

@@ -36,6 +36,13 @@
  *
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

select_buf.c

@@ -32,6 +32,13 @@
  *
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

select_core.c

@@ -32,6 +32,13 @@
  *  2007-01-26  date, identity, identity_info support added (gergo)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <stdlib.h> 
 #include "select.h"
 #include "select_core.h"

ser_stun.c

@@ -30,6 +30,13 @@
  *  2006-12-14  fixed calculation of body length (vlada) 
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #ifdef USE_STUN 
  
 #include <arpa/inet.h>

signals.c

@@ -32,6 +32,13 @@
  *  2005-10-05  split from main.c  (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "signals.h"
 #include "dprint.h"
 

sip_msg_clone.c

@@ -24,6 +24,13 @@
  *  2009-07-22  initial version: functions moved from tm/sip_msg.c (andrei)
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "sip_msg_clone.h"
 
 

socket_info.c

@@ -42,6 +42,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <string.h>
 #include <errno.h>
 #include <unistd.h>

sr_compat.c

@@ -15,10 +15,13 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/**
- * @file 
- * @brief  ser/kamailio/openser compatibility macros & vars.
+/*!
+ * \file
+ * \brief SIP-router core :: ser/kamailio/openser compatibility macros & vars.
+ * \ingroup core
+ * Module: \ref core
  */
+
 /* 
  * History:
  * --------

sr_module.c

@@ -41,6 +41,12 @@
  *  2008-11-26  added fparam_free_contents() and fix_param_types (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
 
 #include "sr_module.h"
 #include "dprint.h"

stats.c

@@ -32,6 +32,13 @@
  * 2003-03-19: added support for route type in find_export (janakj)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #ifdef STATS
 #include "stats.h"

switch.c

@@ -25,6 +25,13 @@
  *  2009-02-19  string and RE switch support added (andrei)
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "switch.h"
 #include "rvalue.h"
 #include "route.h"

tcp_main.c

@@ -105,6 +105,13 @@
  *               send flags (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 
 #ifdef USE_TCP
 

tcp_options.c

@@ -24,6 +24,13 @@
  *  2009-03-05  use cfg framework (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "tcp_options.h"
 #include "dprint.h"
 #include "globals.h"

tcp_read.c

@@ -44,6 +44,13 @@
  * 2009-04-09  tcp ev and tcp stats macros added (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #ifdef USE_TCP
 
 #include <stdio.h>

timer.c

@@ -38,6 +38,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "timer.h"
 #include "timer_funcs.h"
 #include "timer_ticks.h"

timer_proc.c

@@ -25,6 +25,13 @@
  *  2009-03-10  initial version (andrei)
 */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include "timer_proc.h"
 #include "pt.h"
 #include "mem/shm_mem.h"

tsend.c

@@ -34,6 +34,13 @@
  *  2006-02-03  tsend* will wait forever if timeout==-1 (andrei)
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <string.h>
 #include <errno.h>
 #include <sys/poll.h>

udp_server.c

@@ -44,6 +44,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <stdlib.h>
 #include <string.h>
 #include <sys/types.h>

usr_avp.c

@@ -34,6 +34,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <assert.h>
 #include <ctype.h>
 #include <string.h>

ut.c

@@ -29,6 +29,13 @@
  */
 
 
+/*!
+ * \file
+ * \brief SIP-router core :: 
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #include <sys/types.h>
 #include <pwd.h>
 #include <grp.h>