Core Update of doxygen, removal of history, changing "ser" to "kamailio"
authorOlle E. Johansson <oej@edvina.net>
Sat, 3 Jan 2015 14:03:24 +0000 (15:03 +0100)
committerOlle E. Johansson <oej@edvina.net>
Sat, 3 Jan 2015 14:03:24 +0000 (15:03 +0100)
44 files changed:
kstats_types.h
list.h
local_timer.h
lock_alloc.h
lock_ops.h
lock_ops_init.h
locking.h
lump_struct.h
lvalue.h
md5utils.h
mod_fix.h
modparam.h
msg_translator.h
name_alias.h
nonsip_hooks.h
onsend.h
pass_fd.h
poll_types.h
ppcfg.h
proxy.h
pt.h
pv_core.h
pvapi.h
pvar.h
qvalue.h
rad_dict.h
raw_listener.h
raw_sock.h
re.h
receive.h
resolve.h
route.h
route_struct.h
rpc.h
rpc_lookup.h
rvalue.h
sched_yield.h
script_cb.h
sctp_core.h
select.h
select_buf.h
select_core.h
ser_time.h
shm_init.h

index 3d4d9f2..11a4d34 100644 (file)
@@ -13,7 +13,8 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/** kamailio statistics types.
+
+/** Kamailio Core :: kamailio statistics types.
  * This file contains type declaration for kamailio statistics.
  * They are needed when modules are loaded (sr_module.c).
  * The rest of kamailio stats are in lib/kcore (include
  * Note: kamailio statistics are obsolete. Use sr counters in new code
  * (counters.h).
  * @file kstats_types.h
- * @ingroup: core
+ * @ingroup core
+ * @author andrei
  */
-/*
- * History:
- * --------
- *  2010-08-18  initial version (andrei)
-*/
 
 #ifndef __kstats_types_h
 #define __kstats_types_h
diff --git a/list.h b/list.h
index d712253..bdbecca 100644 (file)
--- a/list.h
+++ b/list.h
@@ -1,4 +1,4 @@
-/*-
+/*
  * Copyright (c) 1991, 1993
  *     The Regents of the University of California.  All rights reserved.
  *
index 75503ce..e981809 100644 (file)
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/* local timer routines
+/*!
+* \file
+* \brief Kamailio core :: local timer routines
+* \ingroup core
+* \author andrei
+* Module: \ref core
+*
  * WARNING: this should be used only from within the same process.
  * The local timers are not multi-process or multi-thread safe 
  *  (there are no locks)
  *
- * History:
- * --------
- *  2007-11-22  created by andrei
  */
 
 #ifndef _local_timer_h
index 84e9dac..145aa81 100644 (file)
@@ -1,21 +1,20 @@
-/* $Id$ */
 /*
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
+ * For a license to use the Kamailio software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    info@iptel.org
  *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-/*
- *   ser locking library
+/*!
+* \file
+* \brief Kamailio core :: Kamailio locking library
+* \author andrei
+* \ingroup core
+* Module: \ref core
+*
  *   WARNING: don't include this directly include instead locking.h!
- * History:
- * --------
- *  2003-03-06  created by andrei (contains parts of the original locking.h)
- *  2003-03-17  fixed cast warning in shm_free (forced to void*) (andrei)
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
- *              on darwin (andrei)
  *
 Implements: (see also locking.h)
 
index 097d5bb..0baa4e6 100644 (file)
@@ -1,4 +1,3 @@
-/* $Id$ */
 /*
  *
  * Copyright (C) 2001-2003 FhG Fokus
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/*
- *   ser locking library
+/*!
+* \file
+* \brief Kamailio core :: Kamailio locking library
+* \ingroup core
+* \author andrei
+* Module: \ref core
+*
  *   WARNING: do not include this file directly, use instead locking.h
  *   (unless you don't need to alloc/dealloc locks)
  *
- *  2002-12-16  created by andrei
- *  2003-02-20  s/gen_lock_t/gen_lock_t/ to avoid a type conflict 
- *               on solaris  (andrei)
- *  2003-03-05  lock set support added for FAST_LOCK & SYSV (andrei)
- *  2003-03-06  removed *_alloc,*_dealloc & moved them to lock_alloc.h
- *              renamed locking.h to lock_ops.h (all this to solve
- *              the locking.h<->shm_mem.h interdependency) (andrei)
- *  2003-03-10  lock set support added also for PTHREAD_MUTEX & POSIX_SEM
- *               (andrei)
- *  2003-03-17  possible signal interruptions treated for sysv (andrei)
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
- *              on darwin (andrei)
- *  2006-04-04  added lock_try(lock) and lock_set_try(s,i) (andrei)
- *  2007-05-13  added futex support (andrei)
  *
 Implements:
 
index edad6bb..6eff737 100644 (file)
@@ -1,5 +1,4 @@
 /* 
- * $Id$
  * 
  * Copyright (C) 2007 iptelorg GmbH
  *
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * lock_ops init functions
- */
-/* 
- * History:
- * --------
- *  2007-05-14  created by andrei
+/*!
+* \file
+* \brief Kamailio core :: lock_ops init functions
+* \ingroup core
+* \author andrei
+* Module: \ref core
  */
 
 #ifndef __lock_ops_init_h
index 6dfc11f..2d7e934 100644 (file)
--- a/locking.h
+++ b/locking.h
@@ -1,21 +1,15 @@
-/* $Id$ */
 /*
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-/*
- *   ser locking library
+/*!
+* \file
+* \brief Kamailio core :: Kamailio locking library
+* \ingroup core
+* \author andrei
+* Module: \ref core
  *
- *  2002-12-16  created by andrei
- *  2003-02-20  s/gen_lock_t/gen_lock_t/ to avoid a type conflict 
- *               on solaris  (andrei)
- *  2003-03-05  lock set support added for FAST_LOCK & SYSV (andrei)
- *  2003-03-06  split in two: lock_ops.h & lock_alloc.h, to avoid
- *               shm_mem.h<->locking.h interdependency (andrei)
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
- *              on darwin (andrei)
  *
 Implements (in lock_ops.h & lock_alloc.h):
 
index a9e53b2..ba07fa4 100644 (file)
@@ -1,23 +1,17 @@
 /*
- * $Id$
  *
  * adding/removing headers or any other data chunk from a message
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/* History:
- * --------
- *  2003-01-29  s/int/enum ... more convenient for gdb (jiri)
- *  2003-03-31  added subst lumps -- they expand in ip addr, port a.s.o (andrei)
- *  2003-04-01  added opt (condition) lumps (andrei)
- *  2003-04-02  added more subst lumps: SUBST_{SND,RCV}_ALL  
- *              => ip:port;transport=proto (andrei)
- *  2003-10-20  split from data_lump.h (andrei)
- *  2005-03-24  the type of type attribute changed to enum _hdr_types_t (janakj)
- *
- */
-
+/*!
+* \file
+* \brief Kamailio core :: Adding/removing headers or any other data chunk from a message
+* \ingroup core
+* \author jiri, andrei, janakj
+* Module: \ref core
+*/
 
 #ifndef lump_struct_h
 #define lump_struct_h
index b5eccd4..0f48adb 100644 (file)
--- a/lvalue.h
+++ b/lvalue.h
@@ -1,5 +1,4 @@
 /* 
- * $Id$
  * 
  * Copyright (C) 2008 iptelorg GmbH
  *
 /**
  * @file 
  * @brief lvalues (assignment)
- */
-/* 
- * History:
- * --------
- *  2008-11-30  initial version (andrei)
+ * @author andrei
  */
 
 #ifndef __lvalue_h_
index a16c8f3..a8df9cb 100644 (file)
@@ -1,19 +1,14 @@
 /* 
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -25,7 +20,7 @@
 
 /*!
  * \file
- * \brief SIP-router core :: md5 hash support
+ * \brief Kamailio core :: MD5 digest support
  * \ingroup core
  * Module: \ref core
  */
index c7740d0..36c2ec0 100644 (file)
--- a/mod_fix.h
+++ b/mod_fix.h
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2008 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
+
 /**
  * @file mod_fix.h
  * @brief Generic fixup functions for module function parameter.
  * (kamailio compatibility)
+ * @ingroup core
+ * Module: \ref core
  */
 
 #ifndef _mod_fix_h_
index 8974c68..91c6867 100644 (file)
@@ -1,22 +1,14 @@
 /*
- * $Id$
- *
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
+/*!
+* \file
+* \brief Kamailio core :: Module parameter handling (modparam)
+* \ingroup core
+* Module: \ref core
+*/
 
 
 #ifndef modparam_h
index 01b5619..5fa02cf 100644 (file)
@@ -1,21 +1,14 @@
-/*$Id$
- * 
- *
+/*
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History:
- * --------
- * 2003-03-06  totags in outgoing replies bookmarked to enable
- *             ACK/200 tag matching
- *
- * 2003-03-01 VOICE_MAIL defs removed (jiri)
- * 2003-10-08 receive_test function-alized (jiri)
  */
 
+/*!
+* \file
+* \brief Kamailio core :: Message translations
+* \author jiri
+* \ingroup core
+* Module: \ref core
+*/
+
 
 #ifndef  _MSG_TRANSLATOR_H
 #define _MSG_TRANSLATOR_H
index 3493024..bfc15c8 100644 (file)
@@ -1,22 +1,15 @@
 /*
- * $Id$
- *
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/*
- * History:
- * --------
- *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
- *  2003-10-21  support for proto added: proto:host:port (andrei)
- */
+/*!
+* \file
+* \brief Kamailio core :: Name/alias handling
+* \author andrei
+* \ingroup core
+* Module: \ref core
+*/
 
 
 
@@ -52,7 +46,7 @@ extern struct host_alias* aliases;
 
 
 
-/* returns 1 if  name is in the alias list; if port=0, port no is ignored
+/** returns 1 if  name is in the alias list; if port=0, port no is ignored
  * if proto=0, proto is ignored*/
 static inline int grep_aliases(char* name, int len, unsigned short port,
                                                                unsigned short proto)
@@ -74,7 +68,7 @@ static inline int grep_aliases(char* name, int len, unsigned short port,
 
 
 
-/* adds an alias to the list (only if it isn't already there)
+/** adds an alias to the list (only if it isn't already there)
  * if port==0, the alias will match all the ports
  * if proto==0, the alias will match all the protocols
  * returns 1 if a new alias was added, 0 if a matching alias was already on
index 70480e4..42ca35d 100644 (file)
@@ -1,21 +1,14 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2006 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/*
+/*!
+ * \file
+ * \brief Kamailio core :: Non-sip callbacks
  * non-sip callbacks, called whenever a message with protocol != SIP/2.0
  * is received (the message must have at least a sip like first line or
  * else they will be dropped before this callbacks are called
- */
-/* 
- * History:
- * --------
- *  2006-11-29  created by andrei
+ * \ingroup core
+ * \author andrei
+ * Module: \ref core
  */
 
 
index a8a4e6e..2ed68be 100644 (file)
--- a/onsend.h
+++ b/onsend.h
@@ -1,21 +1,14 @@
 /*
- *  $Id$
- *
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/*
- * History:
- * -------
- *  2005-12-11 created by andrei
- *  2009-06-01 Pre- and post-script callbacks of onsend route are executed (Miklos)
+/*!
+ * \file
+ * \brief Kamailio core :: IP address handling
+ * \author andrei
+ * \ingroup core
+ * Module: \ref core
  */
 
-
 #ifndef onsend_h
 #define onsend_h
 
index 76d76f9..e02087e 100644 (file)
--- a/pass_fd.h
+++ b/pass_fd.h
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
+/*!
+* \file
+* \brief Kamailio core :: File descriptor handling
+* \ingroup core
+* Module: \ref core
+*/
 
 #ifndef _pass_fd_h
 #define _pass_fd_h
index 7440c88..fd6767f 100644 (file)
@@ -1,21 +1,14 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/* 
- * io wait poll methods (enum, strings, related function)
- * see io_wait.h for more details
- * 
- *  
+/*!
+ * \file
+ * \brief Kamailio core :: I/O wait poll methods (enum, strings, related function)
+ * see \ref io_wait.h for more details
+ * \ingroup core
+ * \author andrei
+ * Module: \ref core
  */
-/* 
- * History:
- * --------
- *  2005-06-15  created by andrei
- */
-
 
 #ifndef _poll_types_h
 #define _poll_types_h
diff --git a/ppcfg.h b/ppcfg.h
index d940f86..69f41d2 100644 (file)
--- a/ppcfg.h
+++ b/ppcfg.h
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2010 Daniel-Constantin Mierla (asipto.com)
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * ppcfg.h - config preprocessor directives
+/*!
+ * \file
+ * \brief Kamailio core :: Config preprocessor directives
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef _PPCFG_H_
diff --git a/proxy.h b/proxy.h
index 59f3a3e..e087240 100644 (file)
--- a/proxy.h
+++ b/proxy.h
@@ -1,22 +1,14 @@
 /*
- * $Id$
- *
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
- /*
-  * History:
-  * -------
-  *  2003-02-13  added proto to struct proxy_l & to *_proxy functions (andrei)
-  */
-
+/*!
+ * \file
+ * \brief Kamailio core :: Proxy 
+ * \ingroup core
+ * \author andrei
+ * Module: \ref core
+ */
 
 #ifndef proxy_h
 #define proxy_h
@@ -70,7 +63,7 @@ void free_shm_proxy(struct proxy_l* p);
 
 
 
-/* returns 0 on success, -1 on error (unknown af/bug) */
+/** returns 0 on success, -1 on error (unknown af/bug) */
 inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p)
 {
        /* if error try next ip address if possible */
@@ -87,7 +80,7 @@ inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p)
 
 
 
-/* mark as proxy either as ok (err>=0) or as bad (err<0) */
+/** mark proxy either as ok (err>=0) or as bad (err<0) */
 inline static void proxy_mark(struct proxy_l* p, int err)
 {
        if (err<0){
diff --git a/pt.h b/pt.h
index b52be56..ed351a7 100644 (file)
--- a/pt.h
+++ b/pt.h
@@ -1,10 +1,6 @@
 /*
- * $Id$
- *
  * Process Table
  *
- *
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * History:
- * --------
- *  2003-04-15  added tcp_disable support (andrei)
- *  2006-06-14 added process table in shared mem (dragos)
- *  2007-07-04 added register_fds() and get_max_open_fds(() (andrei)
- */
-/** internal fork functions and process table.
+/** Kamailio core :: internal fork functions and process table.
  * @file: pt.h
  * @ingroup core
  */
 
-
 #ifndef _PT_H
 #define _PT_H
 
index e98480b..5f80556 100644 (file)
--- a/pv_core.h
+++ b/pv_core.h
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2009 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * pv_core.h
- */
+/*!
+* \file
+* \brief Kamailio core :: Pseudovariable handling core
+* \ingroup core
+* Module: \ref core
+*/
 
 #ifndef __pv_core_h
 #define __pv_core_h
diff --git a/pvapi.h b/pvapi.h
index 855e92b..1f2366e 100644 (file)
--- a/pvapi.h
+++ b/pvapi.h
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2009 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * pvapi.h - pvapi init and destroy functions.
+/*!
+ * \file
+ * \brief Kamailio core :: pvapi init and destroy functions.
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef __pvapi_h__
diff --git a/pvar.h b/pvar.h
index 4aa04dc..601f0ef 100644 (file)
--- a/pvar.h
+++ b/pvar.h
@@ -1,16 +1,14 @@
 /*
- * $Id: items.h 2111 2007-05-01 11:18:08Z juhe $
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of SIP-Router, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * SIP-Router is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * SIP-Router is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -22,7 +20,7 @@
 
 /*!
  * \file
- * \brief Definitions for Pseudo-variable support
+ * \brief Kamailio core :: Definitions for Pseudo-variable support
  */
 
 
index 231416d..4e2444b 100644 (file)
--- a/qvalue.h
+++ b/qvalue.h
@@ -1,23 +1,16 @@
 /*
- * $Id$
- *
  * Handling of the q value
  *
  * Copyright (C) 2004 FhG FOKUS
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History
- * ------
- * 2004-04-25 created (janakj)
+ */
+/*!
+ * \file
+ * \brief Kamailio core :: Handling of the Q value
+ * \author janakj
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef _QVALUE_H
index 5354ca9..3f0c260 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2001-2003 FhG FOKUS
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-
-/*
- * WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you 
+/*!
+ * \file
+ * \brief Kamailio core :: Radius include file
+ * \ingroup core
+ * Module: \ref core
+ *
+ * \note WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you 
  * update this file !
  */
 
index 3ac7d84..a171070 100644 (file)
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/** raw socket udp listen functions.
+/** Kamailio core :: raw socket udp listen functions.
  *  @file raw_listener.h
  *  @ingroup core
+ *  @author andrei
  *  Module: @ref core
  */
-/*
- * History:
- * --------
- *  2010-06-09  initial version (from older code) andrei
- */
 
 #ifndef _raw_listener_h
 #define _raw_listener_h
index 868399f..fbb21bf 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * $Id$
- *
  * Copyright (C) 2010 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/** raw socket functions.
+
+/** Kamailio core :: raw socket functions.
  *  @file raw_sock.c
  *  @ingroup core
+ *  @author andrei
  *  Module: @ref core
  */
-/* 
- * History:
- * --------
- *  2010-06-07  initial version (from older code) andrei
- */
 
 #ifndef _raw_sock_h
 #define _raw_sock_h
diff --git a/re.h b/re.h
index 1d6ea34..30d5ff6 100644 (file)
--- a/re.h
+++ b/re.h
@@ -1,23 +1,16 @@
 /*
- * $Id$
- *
  * regexp and regexp substitutions implementations
  * 
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
  *
- * History:
- * --------
- *   2003-08-04  created by andrei
- *   2004-11-12  minor api extension, added *count (andrei)
+ */
+/*!
+ * \file
+ * \brief Kamailio core :: regexp and regexp substitutions implementations
+ * \author andrei
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef _re_h
index a40fdc2..4e6a13d 100644 (file)
--- a/receive.h
+++ b/receive.h
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
+/*!
+* \file
+* \brief Kamailio core :: Receive msg function
+* \ingroup core
+* Module: \ref core
+*/
 
 
 
index 3aa690a..fad783e 100644 (file)
--- a/resolve.h
+++ b/resolve.h
@@ -1,23 +1,16 @@
 /*
- * $Id$
- *
  * resolver related functions
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/* History:
- * --------
- *  2003-04-12  support for resolving ipv6 address references added (andrei)
- *  2004-07-28  darwin needs nameser_compat.h (andrei)
- *  2006-07-13  rdata structures put on diet (andrei)
- *  2006-07-17  rdata contains now also the record name (andrei)
- *  2006-08-18  get_record uses flags (andrei)
- *  2006-06-16  naptr support (andrei)
- */
-
 
+/*!
+ * \file
+ * \brief Kamailio core :: DNS resolver
+ * \author andrei
+ * \ingroup core
+ * Module: \ref core
+ */
 
 #ifndef __resolve_h
 #define __resolve_h
diff --git a/route.h b/route.h
index 4e3aca6..b711c2a 100644 (file)
--- a/route.h
+++ b/route.h
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
+/*!
+* \file
+* \brief Kamailio core :: Message routing
+* \ingroup core
+* Module: \ref core
+*/
 
 
 #ifndef route_h
index 5d1aa15..f1aaac4 100644 (file)
@@ -1,22 +1,14 @@
 /*
- * $Id$
- *
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-/* History:
- * --------
- *
- *  2003-04-12  FORCE_RPORT_T added (andrei)
- *  2003-04-22  strip_tail added (jiri)
- *  2003-10-10  >,<,>=,<=, != and MSGLEN_O added (andrei)
- *  2003-10-28  FORCE_TCP_ALIAS added (andrei)
- *  2004-02-24  added LOAD_AVP_T and AVP_TO_URI_T (bogdan)
- *  2005-12-11  added SND{IP,PORT,PROTO,AF}_O & TO{IP,PORT}_O (andrei)
- *  2005-12-19  select framework added SELECT_O and SELECT_ST (mma)
- *  2008-12-17  added UDP_MTU_TRY_PROTO_T (andrei)
+/*!
+ * \file
+ * \brief Kamailio core :: Route structure
+ * \ingroup core
+ * Module: \ref core
+ * \author andrei, bogdan
  */
 
-
 #ifndef route_struct_h
 #define route_struct_h
 
diff --git a/rpc.h b/rpc.h
index 91c1463..0eefc99 100644 (file)
--- a/rpc.h
+++ b/rpc.h
@@ -1,22 +1,16 @@
-/* $Id$
- *
- * SER Remote Procedure Call Interface
+/* 
+ * Kamailio Remote Procedure Call Interface
  *
  * Copyright (C) 2005 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+/*!
+* \file
+* \brief Kamailio core :: RPC, Remote procedure call interface
+* \ingroup core
+* Module: \ref core
+*/
+
 #ifndef _RPC_H
 #define _RPC_H
 
@@ -46,15 +47,15 @@ struct rpc_delayed_ctx;
 
 
 /* Send the result to the caller */
-typedef int (*rpc_send_f)(void* ctx);                                      /* Send the reply to the client */
-typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /* Signal a failure to the client */
-typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /* Add a new piece of data to the result */
-typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /* Retrieve request parameters */
-typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /* Add printf-like formated data to the result set */
-typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /* Add fields in a structure */
-typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /* Add values in an array */
-typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /* Scan attributes of a structure */
-typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */
+typedef int (*rpc_send_f)(void* ctx);                                      /*!< Send the reply to the client */
+typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /*!< Signal a failure to the client */
+typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /*!< Add a new piece of data to the result */
+typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /*!< Retrieve request parameters */
+typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /*!< Add printf-like formated data to the result set */
+typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /*!< Add fields in a structure */
+typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /*!< Add values in an array */
+typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /*!< Scan attributes of a structure */
+typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /*!< Struct version of rpc_printf */
 
 /* returns the supported capabilities */
 typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx);
@@ -91,13 +92,12 @@ typedef struct rpc_delayed_ctx{
 } rpc_delayed_ctx_t;
 
 
-/*
+/**
  * RPC Function Prototype
  */
-
 typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx);
 
-/*
+/**
  * RPC callback context.
  *
  * Defines a convenient way of packing an rpc callback
@@ -110,14 +110,14 @@ typedef struct rpc_cb_ctx {
 } rpc_cb_ctx_t;
 
 
-/*
+/**
  * Remote Procedure Call Export
  */
 typedef struct rpc_export {
-       const char* name;        /* Name of the RPC function (null terminated) */
-       rpc_function_t function; /* Pointer to the function */
-       const char** doc_str;  /* Documentation strings, method signature and description */
-       unsigned int flags;      /* Various flags, reserved for future use */
+       const char* name;        /*!< Name of the RPC function (null terminated) */
+       rpc_function_t function; /*!< Pointer to the function */
+       const char** doc_str;  /*!< Documentation strings, method signature and description */
+       unsigned int flags;      /*!< Various flags, reserved for future use */
 } rpc_export_t;
 
 
index 53d40b6..fb199af 100644 (file)
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2009 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * SER RPC lookup and register functions
+/*!
+ * \file
+ * \brief Kamailio core :: Kamailio RPC lookup and register functions
+ * \ingroup core
+ * Module: \ref core
+ * \author andrei
  */
-/*
- * History:
- * --------
- *  2009-05-11  initial version (andrei)
-*/
 
 #ifndef __rpc_lookup_h
 #define __rpc_lookup_h
index c0c2e0e..ccedfe5 100644 (file)
--- a/rvalue.h
+++ b/rvalue.h
  * @brief SIP-router core :: rvalue expressions
  * @ingroup core
  * Module: \ref core
+ * @author andrei
  */
  
-/* 
- * History:
- * --------
- *  2008-11-30  initial version (andrei)
- *  2009-04-28  added string and interger versions for the EQ and DIFF
- *              operators (andrei)
- *  2009-05-05  casts operator for int & string (andrei)
- *  2010-03-16  space for an int2str result inside rval_cache (andrei)
- */
-
 #ifndef _rvalue_h_
 #define _rvalue_h_
 
index 45030c5..1f8546d 100644 (file)
@@ -1,10 +1,6 @@
 /*
  * sched_yield wrapper
  *
- * $Id$
- *
- * 
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- *
- *History:
- *--------
- *  2007-07-13  splitted from fastlock.h (andrei)
+/*!
+ * \file
+ * \brief Kamailio core :: Sched_yield wrapper
+ * \ingroup core
+ * Module: \ref core
+ * \author andrei
  */
 
-
 #ifndef _sched_yield_h
 #define _sched_yield_h
 
index 65361a0..ece69b8 100644 (file)
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History:
- * --------
- *  2005-02-13  script callbacks devided into request and reply types (bogdan)
- *  2009-06-01  Added pre- and post-script callback support for all types
- *             of route blocks. (Miklos)
+ */
+/*!
+ * \file
+ * \brief Kamailio core :: Script callbacks
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef _SCRIPT_CB_H_
index 88e0470..c6b65b0 100644 (file)
@@ -1,6 +1,4 @@
 /**
- * $Id$
- *
  * Copyright (C) 2013 Daniel-Constantin Mierla (asipto.com)
  *
  * This file is part of Kamailio, a free SIP server.
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
+/*!
+ * \file
+ * \brief Kamailio core :: SCTP support
+ * \ingroup core
+ * Module: \ref core
+ * Copyright (C) 2013 Daniel-Constantin Mierla (asipto.com)
+ */
 
 #ifndef __sctp_core_h__
 #define __sctp_core_h__
index 3ed5c5b..5d639d6 100644 (file)
--- a/select.h
+++ b/select.h
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2005-2006 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History:
- * --------
- *  2005-12-19  select framework (mma)
- *  2006-01-19  multiple nested calls, IS_ALIAS -> NESTED flag renamed (mma)
+ */
+/*!
+ * \file
+ * \brief Kamailio core :: Selcct Framework
+ * \author mma
+ * \ingroup core
+ * Module: \ref core
  */
 
  
index 6543fbf..d8b7c54 100644 (file)
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2005-2006 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History:
- * --------
- *     2006-06-16  static buffer for select results (mma)
- *                 each process owns a separate space
- *                 each request starts using the buffer from the start
- *
+ */
+
+/*!
+ * \file
+ * \brief Kamailio core :: Select result buffers
+ * \author mma
+ * \ingroup core
+ * Module: \ref core
  */
 
 #ifndef SELECT_BUFFER_H
@@ -37,7 +32,7 @@
 
 #include "str.h"
 
-/*
+/**
  * Request for space from buffer
  *
  * Returns:  NULL  memory allocation failure (no more space)
 
 char* get_static_buffer(int req_size);
 
-/* Internal function - called before request is going to be processed
+/** Internal function - called before request is going to be processed
  *
  * Reset offset to unused space
  */
-
 int reset_static_buffer(void);
 
 int str_to_static_buffer(str* res, str* s);
index a3192e4..7f03a92 100644 (file)
@@ -1,21 +1,14 @@
 /*
- * $Id$
- *
  * Copyright (C) 2005-2006 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of Kamailio, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * Kamailio is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * Kamailio is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * History:
- * --------
- *  2005-12-19  select framework, basic core functions (mma)
- *  2006-01-19  multiple nested calls, IS_ALIAS -> NESTED flag renamed (mma)
- *  2007-01-26  date, identity, identity_info support added (gergo)
  */
 
+/*!
+* \file
+* \brief Kamailio core :: Select framework, basic core functions
+* \author mma
+* \ingroup core
+* Module: \ref core
+*/
+
  
 #ifndef _SELECT_CORE_H
 #define _SELECT_CORE_H
index 70da002..e4a0000 100644 (file)
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * time related functions
  *
  * Copyright (C) 2006 iptelorg GmbH
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/* History:
- * --------
- *  2008-07-16  initial version (andrei)
+
+/*!
+ * \file
+ * \brief Kamailio core :: Time related functions
+ * \author andrei
+ * \ingroup core
+ * Module: \ref core
  */
 #ifndef _ser_time_h
 #define _ser_time_h
index 1e0d76f..60b233f 100644 (file)
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2010 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-/*
- * shm_init.h
- */
-/*
- * History:
- * --------
- *  2010-01-10  initial version (andrei)
+/*!
+* \file
+* \brief Kamailio core :: Shared memory initialization
+* \ingroup core
+* \author andrei
+* Module: \ref core
 */
 
 #ifndef __shm_init_h