Browse code

Core Update of doxygen, removal of history, changing "ser" to "kamailio"

Olle E. Johansson authored on 03/01/2015 14:03:24
Showing 44 changed files
... ...
@@ -13,7 +13,8 @@
13 13
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 14
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 15
  */
16
-/** kamailio statistics types.
16
+
17
+/** Kamailio Core :: kamailio statistics types.
17 18
  * This file contains type declaration for kamailio statistics.
18 19
  * They are needed when modules are loaded (sr_module.c).
19 20
  * The rest of kamailio stats are in lib/kcore (include
... ...
@@ -22,13 +23,9 @@
22 22
  * Note: kamailio statistics are obsolete. Use sr counters in new code
23 23
  * (counters.h).
24 24
  * @file kstats_types.h
25
- * @ingroup: core
25
+ * @ingroup core
26
+ * @author andrei
26 27
  */
27
-/*
28
- * History:
29
- * --------
30
- *  2010-08-18  initial version (andrei)
31
-*/
32 28
 
33 29
 #ifndef __kstats_types_h
34 30
 #define __kstats_types_h
... ...
@@ -1,4 +1,4 @@
1
-/*-
1
+/*
2 2
  * Copyright (c) 1991, 1993
3 3
  *	The Regents of the University of California.  All rights reserved.
4 4
  *
... ...
@@ -1,21 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2007 iptelorg GmbH
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,14 +17,17 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
-/* local timer routines
27
+/*!
28
+* \file
29
+* \brief Kamailio core :: local timer routines
30
+* \ingroup core
31
+* \author andrei
32
+* Module: \ref core
33
+*
28 34
  * WARNING: this should be used only from within the same process.
29 35
  * The local timers are not multi-process or multi-thread safe 
30 36
  *  (there are no locks)
31 37
  *
32
- * History:
33
- * --------
34
- *  2007-11-22  created by andrei
35 38
  */
36 39
 
37 40
 #ifndef _local_timer_h
... ...
@@ -1,21 +1,20 @@
1
-/* $Id$ */
2 1
 /*
3 2
  *
4 3
  * Copyright (C) 2001-2003 FhG Fokus
5 4
  *
6
- * This file is part of ser, a free SIP server.
5
+ * This file is part of Kamailio, a free SIP server.
7 6
  *
8
- * ser is free software; you can redistribute it and/or modify
7
+ * Kamailio is free software; you can redistribute it and/or modify
9 8
  * it under the terms of the GNU General Public License as published by
10 9
  * the Free Software Foundation; either version 2 of the License, or
11 10
  * (at your option) any later version
12 11
  *
13
- * For a license to use the ser software under conditions
12
+ * For a license to use the Kamailio software under conditions
14 13
  * other than those described here, or to purchase support for this
15 14
  * software, please contact iptel.org by e-mail at the following addresses:
16 15
  *    info@iptel.org
17 16
  *
18
- * ser is distributed in the hope that it will be useful,
17
+ * Kamailio is distributed in the hope that it will be useful,
19 18
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 19
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 20
  * GNU General Public License for more details.
... ...
@@ -25,15 +24,14 @@
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27 27
 
28
-/*
29
- *   ser locking library
28
+/*!
29
+* \file
30
+* \brief Kamailio core :: Kamailio locking library
31
+* \author andrei
32
+* \ingroup core
33
+* Module: \ref core
34
+*
30 35
  *   WARNING: don't include this directly include instead locking.h!
31
- * History:
32
- * --------
33
- *  2003-03-06  created by andrei (contains parts of the original locking.h)
34
- *  2003-03-17  fixed cast warning in shm_free (forced to void*) (andrei)
35
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
36
- *              on darwin (andrei)
37 36
  *
38 37
 Implements: (see also locking.h)
39 38
 
... ...
@@ -1,4 +1,3 @@
1
-/* $Id$ */
2 1
 /*
3 2
  *
4 3
  * Copyright (C) 2001-2003 FhG Fokus
... ...
@@ -16,25 +15,16 @@
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18 18
 
19
-/*
20
- *   ser locking library
19
+/*!
20
+* \file
21
+* \brief Kamailio core :: Kamailio locking library
22
+* \ingroup core
23
+* \author andrei
24
+* Module: \ref core
25
+*
21 26
  *   WARNING: do not include this file directly, use instead locking.h
22 27
  *   (unless you don't need to alloc/dealloc locks)
23 28
  *
24
- *  2002-12-16  created by andrei
25
- *  2003-02-20  s/gen_lock_t/gen_lock_t/ to avoid a type conflict 
26
- *               on solaris  (andrei)
27
- *  2003-03-05  lock set support added for FAST_LOCK & SYSV (andrei)
28
- *  2003-03-06  removed *_alloc,*_dealloc & moved them to lock_alloc.h
29
- *              renamed locking.h to lock_ops.h (all this to solve
30
- *              the locking.h<->shm_mem.h interdependency) (andrei)
31
- *  2003-03-10  lock set support added also for PTHREAD_MUTEX & POSIX_SEM
32
- *               (andrei)
33
- *  2003-03-17  possible signal interruptions treated for sysv (andrei)
34
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
35
- *              on darwin (andrei)
36
- *  2006-04-04  added lock_try(lock) and lock_set_try(s,i) (andrei)
37
- *  2007-05-13  added futex support (andrei)
38 29
  *
39 30
 Implements:
40 31
 
... ...
@@ -1,5 +1,4 @@
1 1
 /* 
2
- * $Id$
3 2
  * 
4 3
  * Copyright (C) 2007 iptelorg GmbH
5 4
  *
... ...
@@ -15,13 +14,12 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/*
19
- * lock_ops init functions
20
- */
21
-/* 
22
- * History:
23
- * --------
24
- *  2007-05-14  created by andrei
18
+/*!
19
+* \file
20
+* \brief Kamailio core :: lock_ops init functions
21
+* \ingroup core
22
+* \author andrei
23
+* Module: \ref core
25 24
  */
26 25
 
27 26
 #ifndef __lock_ops_init_h
... ...
@@ -1,21 +1,15 @@
1
-/* $Id$ */
2 1
 /*
3 2
  *
4 3
  * Copyright (C) 2001-2003 FhG Fokus
5 4
  *
6
- * This file is part of ser, a free SIP server.
5
+ * This file is part of Kamailio, a free SIP server.
7 6
  *
8
- * ser is free software; you can redistribute it and/or modify
7
+ * Kamailio is free software; you can redistribute it and/or modify
9 8
  * it under the terms of the GNU General Public License as published by
10 9
  * the Free Software Foundation; either version 2 of the License, or
11 10
  * (at your option) any later version
12 11
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
12
+ * Kamailio is distributed in the hope that it will be useful,
19 13
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 14
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 15
  * GNU General Public License for more details.
... ...
@@ -25,17 +19,13 @@
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27 27
 
28
-/*
29
- *   ser locking library
28
+/*!
29
+* \file
30
+* \brief Kamailio core :: Kamailio locking library
31
+* \ingroup core
32
+* \author andrei
33
+* Module: \ref core
30 34
  *
31
- *  2002-12-16  created by andrei
32
- *  2003-02-20  s/gen_lock_t/gen_lock_t/ to avoid a type conflict 
33
- *               on solaris  (andrei)
34
- *  2003-03-05  lock set support added for FAST_LOCK & SYSV (andrei)
35
- *  2003-03-06  split in two: lock_ops.h & lock_alloc.h, to avoid
36
- *               shm_mem.h<->locking.h interdependency (andrei)
37
- *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
38
- *              on darwin (andrei)
39 35
  *
40 36
 Implements (in lock_ops.h & lock_alloc.h):
41 37
 
... ...
@@ -1,23 +1,17 @@
1 1
 /*
2
- * $Id$
3 2
  *
4 3
  * adding/removing headers or any other data chunk from a message
5 4
  *
6 5
  * Copyright (C) 2001-2003 FhG Fokus
7 6
  *
8
- * This file is part of ser, a free SIP server.
7
+ * This file is part of Kamailio, a free SIP server.
9 8
  *
10
- * ser is free software; you can redistribute it and/or modify
9
+ * Kamailio is free software; you can redistribute it and/or modify
11 10
  * it under the terms of the GNU General Public License as published by
12 11
  * the Free Software Foundation; either version 2 of the License, or
13 12
  * (at your option) any later version
14 13
  *
15
- * For a license to use the ser software under conditions
16
- * other than those described here, or to purchase support for this
17
- * software, please contact iptel.org by e-mail at the following addresses:
18
- *    info@iptel.org
19
- *
20
- * ser is distributed in the hope that it will be useful,
14
+ * Kamailio is distributed in the hope that it will be useful,
21 15
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 16
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 17
  * GNU General Public License for more details.
... ...
@@ -26,18 +20,13 @@
26 26
  * along with this program; if not, write to the Free Software 
27 27
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28 28
  */
29
-/* History:
30
- * --------
31
- *  2003-01-29  s/int/enum ... more convenient for gdb (jiri)
32
- *  2003-03-31  added subst lumps -- they expand in ip addr, port a.s.o (andrei)
33
- *  2003-04-01  added opt (condition) lumps (andrei)
34
- *  2003-04-02  added more subst lumps: SUBST_{SND,RCV}_ALL  
35
- *              => ip:port;transport=proto (andrei)
36
- *  2003-10-20  split from data_lump.h (andrei)
37
- *  2005-03-24  the type of type attribute changed to enum _hdr_types_t (janakj)
38
- *
39
- */
40
-
29
+/*!
30
+* \file
31
+* \brief Kamailio core :: Adding/removing headers or any other data chunk from a message
32
+* \ingroup core
33
+* \author jiri, andrei, janakj
34
+* Module: \ref core
35
+*/
41 36
 
42 37
 #ifndef lump_struct_h
43 38
 #define lump_struct_h
... ...
@@ -1,5 +1,4 @@
1 1
 /* 
2
- * $Id$
3 2
  * 
4 3
  * Copyright (C) 2008 iptelorg GmbH
5 4
  *
... ...
@@ -18,11 +17,7 @@
18 18
 /**
19 19
  * @file 
20 20
  * @brief lvalues (assignment)
21
- */
22
-/* 
23
- * History:
24
- * --------
25
- *  2008-11-30  initial version (andrei)
21
+ * @author andrei
26 22
  */
27 23
 
28 24
 #ifndef __lvalue_h_
... ...
@@ -1,19 +1,14 @@
1 1
 /* 
2 2
  * Copyright (C) 2001-2003 FhG Fokus
3 3
  *
4
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
5 5
  *
6
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
7 7
  * it under the terms of the GNU General Public License as published by
8 8
  * the Free Software Foundation; either version 2 of the License, or
9 9
  * (at your option) any later version
10 10
  *
11
- * For a license to use the ser software under conditions
12
- * other than those described here, or to purchase support for this
13
- * software, please contact iptel.org by e-mail at the following addresses:
14
- *    info@iptel.org
15
- *
16
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
17 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 14
  * GNU General Public License for more details.
... ...
@@ -25,7 +20,7 @@
25 25
 
26 26
 /*!
27 27
  * \file
28
- * \brief SIP-router core :: md5 hash support
28
+ * \brief Kamailio core :: MD5 digest support
29 29
  * \ingroup core
30 30
  * Module: \ref core
31 31
  */
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2008 iptelorg GmbH
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,10 +13,13 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
+
18 19
 /**
19 20
  * @file mod_fix.h
20 21
  * @brief Generic fixup functions for module function parameter.
21 22
  * (kamailio compatibility)
23
+ * @ingroup core
24
+ * Module: \ref core
22 25
  */
23 26
 
24 27
 #ifndef _mod_fix_h_
... ...
@@ -1,22 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4
- *
5 2
  * Copyright (C) 2001-2003 FhG Fokus
6 3
  *
7
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
8 5
  *
9
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
10 7
  * it under the terms of the GNU General Public License as published by
11 8
  * the Free Software Foundation; either version 2 of the License, or
12 9
  * (at your option) any later version
13 10
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
20 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 14
  * GNU General Public License for more details.
... ...
@@ -25,6 +17,12 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
27 27
  */
28
+/*!
29
+* \file
30
+* \brief Kamailio core :: Module parameter handling (modparam)
31
+* \ingroup core
32
+* Module: \ref core
33
+*/
28 34
 
29 35
 
30 36
 #ifndef modparam_h
... ...
@@ -1,21 +1,14 @@
1
-/*$Id$
2
- * 
3
- *
1
+/*
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,15 +17,16 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  *
27
- * History:
28
- * --------
29
- * 2003-03-06  totags in outgoing replies bookmarked to enable
30
- *             ACK/200 tag matching
31
- *
32
- * 2003-03-01 VOICE_MAIL defs removed (jiri)
33
- * 2003-10-08 receive_test function-alized (jiri)
34 27
  */
35 28
 
29
+/*!
30
+* \file
31
+* \brief Kamailio core :: Message translations
32
+* \author jiri
33
+* \ingroup core
34
+* Module: \ref core
35
+*/
36
+
36 37
 
37 38
 #ifndef  _MSG_TRANSLATOR_H
38 39
 #define _MSG_TRANSLATOR_H
... ...
@@ -1,22 +1,15 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  *
5 3
  * Copyright (C) 2001-2003 FhG Fokus
6 4
  *
7
- * This file is part of ser, a free SIP server.
5
+ * This file is part of Kamailio, a free SIP server.
8 6
  *
9
- * ser is free software; you can redistribute it and/or modify
7
+ * Kamailio is free software; you can redistribute it and/or modify
10 8
  * it under the terms of the GNU General Public License as published by
11 9
  * the Free Software Foundation; either version 2 of the License, or
12 10
  * (at your option) any later version
13 11
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19
- * ser is distributed in the hope that it will be useful,
12
+ * Kamailio is distributed in the hope that it will be useful,
20 13
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 14
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 15
  * GNU General Public License for more details.
... ...
@@ -25,12 +18,13 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
27 27
  */
28
-/*
29
- * History:
30
- * --------
31
- *  2003-03-19  replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei)
32
- *  2003-10-21  support for proto added: proto:host:port (andrei)
33
- */
28
+/*!
29
+* \file
30
+* \brief Kamailio core :: Name/alias handling
31
+* \author andrei
32
+* \ingroup core
33
+* Module: \ref core
34
+*/
34 35
 
35 36
 
36 37
 
... ...
@@ -52,7 +46,7 @@ extern struct host_alias* aliases;
52 52
 
53 53
 
54 54
 
55
-/* returns 1 if  name is in the alias list; if port=0, port no is ignored
55
+/** returns 1 if  name is in the alias list; if port=0, port no is ignored
56 56
  * if proto=0, proto is ignored*/
57 57
 static inline int grep_aliases(char* name, int len, unsigned short port,
58 58
 								unsigned short proto)
... ...
@@ -74,7 +68,7 @@ static inline int grep_aliases(char* name, int len, unsigned short port,
74 74
 
75 75
 
76 76
 
77
-/* adds an alias to the list (only if it isn't already there)
77
+/** adds an alias to the list (only if it isn't already there)
78 78
  * if port==0, the alias will match all the ports
79 79
  * if proto==0, the alias will match all the protocols
80 80
  * returns 1 if a new alias was added, 0 if a matching alias was already on
... ...
@@ -1,21 +1,14 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2006 iptelorg GmbH
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,15 +17,15 @@
24 24
  * along with this program; if not, write to the Free Software
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
-/*
27
+/*!
28
+ * \file
29
+ * \brief Kamailio core :: Non-sip callbacks
28 30
  * non-sip callbacks, called whenever a message with protocol != SIP/2.0
29 31
  * is received (the message must have at least a sip like first line or
30 32
  * else they will be dropped before this callbacks are called
31
- */
32
-/* 
33
- * History:
34
- * --------
35
- *  2006-11-29  created by andrei
33
+ * \ingroup core
34
+ * \author andrei
35
+ * Module: \ref core
36 36
  */
37 37
 
38 38
 
... ...
@@ -1,21 +1,14 @@
1 1
 /*
2
- *  $Id$
3
- *
4 2
  * Copyright (C) 2005 iptelorg GmbH
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,14 +17,14 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
-/*
28
- * History:
29
- * -------
30
- *  2005-12-11 created by andrei
31
- *  2009-06-01 Pre- and post-script callbacks of onsend route are executed (Miklos)
27
+/*!
28
+ * \file
29
+ * \brief Kamailio core :: IP address handling
30
+ * \author andrei
31
+ * \ingroup core
32
+ * Module: \ref core
32 33
  */
33 34
 
34
-
35 35
 #ifndef onsend_h
36 36
 #define onsend_h
37 37
 
... ...
@@ -1,21 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,6 +17,12 @@
24 24
  * along with this program; if not, write to the Free Software
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
+/*!
28
+* \file
29
+* \brief Kamailio core :: File descriptor handling
30
+* \ingroup core
31
+* Module: \ref core
32
+*/
27 33
 
28 34
 #ifndef _pass_fd_h
29 35
 #define _pass_fd_h
... ...
@@ -1,21 +1,14 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2005 iptelorg GmbH
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,18 +17,14 @@
24 24
  * along with this program; if not, write to the Free Software
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
-/* 
28
- * io wait poll methods (enum, strings, related function)
29
- * see io_wait.h for more details
30
- * 
31
- *  
27
+/*!
28
+ * \file
29
+ * \brief Kamailio core :: I/O wait poll methods (enum, strings, related function)
30
+ * see \ref io_wait.h for more details
31
+ * \ingroup core
32
+ * \author andrei
33
+ * Module: \ref core
32 34
  */
33
-/* 
34
- * History:
35
- * --------
36
- *  2005-06-15  created by andrei
37
- */
38
-
39 35
 
40 36
 #ifndef _poll_types_h
41 37
 #define _poll_types_h
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2010 Daniel-Constantin Mierla (asipto.com)
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,8 +13,11 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/*
19
- * ppcfg.h - config preprocessor directives
18
+/*!
19
+ * \file
20
+ * \brief Kamailio core :: Config preprocessor directives
21
+ * \ingroup core
22
+ * Module: \ref core
20 23
  */
21 24
 
22 25
 #ifndef _PPCFG_H_
... ...
@@ -1,22 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4
- *
5 2
  * Copyright (C) 2001-2003 FhG Fokus
6 3
  *
7
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
8 5
  *
9
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
10 7
  * it under the terms of the GNU General Public License as published by
11 8
  * the Free Software Foundation; either version 2 of the License, or
12 9
  * (at your option) any later version
13 10
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
20 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 14
  * GNU General Public License for more details.
... ...
@@ -25,12 +17,13 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
27 27
  */
28
- /*
29
-  * History:
30
-  * -------
31
-  *  2003-02-13  added proto to struct proxy_l & to *_proxy functions (andrei)
32
-  */
33
-
28
+/*!
29
+ * \file
30
+ * \brief Kamailio core :: Proxy 
31
+ * \ingroup core
32
+ * \author andrei
33
+ * Module: \ref core
34
+ */
34 35
 
35 36
 #ifndef proxy_h
36 37
 #define proxy_h
... ...
@@ -70,7 +63,7 @@ void free_shm_proxy(struct proxy_l* p);
70 70
 
71 71
 
72 72
 
73
-/* returns 0 on success, -1 on error (unknown af/bug) */
73
+/** returns 0 on success, -1 on error (unknown af/bug) */
74 74
 inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p)
75 75
 {
76 76
 	/* if error try next ip address if possible */
... ...
@@ -87,7 +80,7 @@ inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p)
87 87
 
88 88
 
89 89
 
90
-/* mark as proxy either as ok (err>=0) or as bad (err<0) */
90
+/** mark proxy either as ok (err>=0) or as bad (err<0) */
91 91
 inline static void proxy_mark(struct proxy_l* p, int err)
92 92
 {
93 93
 	if (err<0){
... ...
@@ -1,10 +1,6 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Process Table
5 3
  *
6
- *
7
- *
8 4
  * Copyright (C) 2001-2003 FhG Fokus
9 5
  *
10 6
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -19,19 +15,11 @@
19 19
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20 20
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 21
  */
22
-/*
23
- * History:
24
- * --------
25
- *  2003-04-15  added tcp_disable support (andrei)
26
- *  2006-06-14	added process table in shared mem (dragos)
27
- *  2007-07-04	added register_fds() and get_max_open_fds(() (andrei)
28
- */
29
-/** internal fork functions and process table.
22
+/** Kamailio core :: internal fork functions and process table.
30 23
  * @file: pt.h
31 24
  * @ingroup core
32 25
  */
33 26
 
34
-
35 27
 #ifndef _PT_H
36 28
 #define _PT_H
37 29
 
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2009 iptelorg GmbH
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,9 +13,12 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/*
19
- * pv_core.h
20
- */
18
+/*!
19
+* \file
20
+* \brief Kamailio core :: Pseudovariable handling core
21
+* \ingroup core
22
+* Module: \ref core
23
+*/
21 24
 
22 25
 #ifndef __pv_core_h
23 26
 #define __pv_core_h
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2009 iptelorg GmbH
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,8 +13,11 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/*
19
- * pvapi.h - pvapi init and destroy functions.
18
+/*!
19
+ * \file
20
+ * \brief Kamailio core :: pvapi init and destroy functions.
21
+ * \ingroup core
22
+ * Module: \ref core
20 23
  */
21 24
 
22 25
 #ifndef __pvapi_h__
... ...
@@ -1,16 +1,14 @@
1 1
 /*
2
- * $Id: items.h 2111 2007-05-01 11:18:08Z juhe $
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6
- * This file is part of SIP-Router, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * SIP-Router is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * SIP-Router is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
14 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 14
  * GNU General Public License for more details.
... ...
@@ -22,7 +20,7 @@
22 22
 
23 23
 /*!
24 24
  * \file
25
- * \brief Definitions for Pseudo-variable support
25
+ * \brief Kamailio core :: Definitions for Pseudo-variable support
26 26
  */
27 27
 
28 28
 
... ...
@@ -1,23 +1,16 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Handling of the q value
5 3
  *
6 4
  * Copyright (C) 2004 FhG FOKUS
7 5
  *
8
- * This file is part of ser, a free SIP server.
6
+ * This file is part of Kamailio, a free SIP server.
9 7
  *
10
- * ser is free software; you can redistribute it and/or modify
8
+ * Kamailio is free software; you can redistribute it and/or modify
11 9
  * it under the terms of the GNU General Public License as published by
12 10
  * the Free Software Foundation; either version 2 of the License, or
13 11
  * (at your option) any later version
14 12
  *
15
- * For a license to use the ser software under conditions
16
- * other than those described here, or to purchase support for this
17
- * software, please contact iptel.org by e-mail at the following addresses:
18
- *    info@iptel.org
19
- *
20
- * ser is distributed in the hope that it will be useful,
13
+ * Kamailio is distributed in the hope that it will be useful,
21 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 16
  * GNU General Public License for more details.
... ...
@@ -26,9 +19,13 @@
26 26
  * along with this program; if not, write to the Free Software 
27 27
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28 28
  *
29
- * History
30
- * ------
31
- * 2004-04-25 created (janakj)
29
+ */
30
+/*!
31
+ * \file
32
+ * \brief Kamailio core :: Handling of the Q value
33
+ * \author janakj
34
+ * \ingroup core
35
+ * Module: \ref core
32 36
  */
33 37
 
34 38
 #ifndef _QVALUE_H
... ...
@@ -3,19 +3,14 @@
3 3
  *
4 4
  * Copyright (C) 2001-2003 FhG FOKUS
5 5
  *
6
- * This file is part of ser, a free SIP server.
6
+ * This file is part of Kamailio, a free SIP server.
7 7
  *
8
- * ser is free software; you can redistribute it and/or modify
8
+ * Kamailio is free software; you can redistribute it and/or modify
9 9
  * it under the terms of the GNU General Public License as published by
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
13
+ * Kamailio is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 16
  * GNU General Public License for more details.
... ...
@@ -24,9 +19,13 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
-
28
-/*
29
- * WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you 
27
+/*!
28
+ * \file
29
+ * \brief Kamailio core :: Radius include file
30
+ * \ingroup core
31
+ * Module: \ref core
32
+ *
33
+ * \note WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you 
30 34
  * update this file !
31 35
  */
32 36
 
... ...
@@ -13,16 +13,12 @@
13 13
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 14
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 15
  */
16
-/** raw socket udp listen functions.
16
+/** Kamailio core :: raw socket udp listen functions.
17 17
  *  @file raw_listener.h
18 18
  *  @ingroup core
19
+ *  @author andrei
19 20
  *  Module: @ref core
20 21
  */
21
-/*
22
- * History:
23
- * --------
24
- *  2010-06-09  initial version (from older code) andrei
25
- */
26 22
 
27 23
 #ifndef _raw_listener_h
28 24
 #define _raw_listener_h
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2010 iptelorg GmbH
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,16 +13,13 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/** raw socket functions.
18
+
19
+/** Kamailio core :: raw socket functions.
19 20
  *  @file raw_sock.c
20 21
  *  @ingroup core
22
+ *  @author andrei
21 23
  *  Module: @ref core
22 24
  */
23
-/* 
24
- * History:
25
- * --------
26
- *  2010-06-07  initial version (from older code) andrei
27
- */
28 25
 
29 26
 #ifndef _raw_sock_h
30 27
 #define _raw_sock_h
... ...
@@ -1,23 +1,16 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * regexp and regexp substitutions implementations
5 3
  * 
6 4
  * Copyright (C) 2001-2003 FhG Fokus
7 5
  *
8
- * This file is part of ser, a free SIP server.
6
+ * This file is part of Kamailio, a free SIP server.
9 7
  *
10
- * ser is free software; you can redistribute it and/or modify
8
+ * Kamailio is free software; you can redistribute it and/or modify
11 9
  * it under the terms of the GNU General Public License as published by
12 10
  * the Free Software Foundation; either version 2 of the License, or
13 11
  * (at your option) any later version
14 12
  *
15
- * For a license to use the ser software under conditions
16
- * other than those described here, or to purchase support for this
17
- * software, please contact iptel.org by e-mail at the following addresses:
18
- *    info@iptel.org
19
- *
20
- * ser is distributed in the hope that it will be useful,
13
+ * Kamailio is distributed in the hope that it will be useful,
21 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 16
  * GNU General Public License for more details.
... ...
@@ -27,10 +20,13 @@
27 27
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28 28
  *
29 29
  *
30
- * History:
31
- * --------
32
- *   2003-08-04  created by andrei
33
- *   2004-11-12  minor api extension, added *count (andrei)
30
+ */
31
+/*!
32
+ * \file
33
+ * \brief Kamailio core :: regexp and regexp substitutions implementations
34
+ * \author andrei
35
+ * \ingroup core
36
+ * Module: \ref core
34 37
  */
35 38
 
36 39
 #ifndef _re_h
... ...
@@ -1,21 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,6 +17,12 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
+/*!
28
+* \file
29
+* \brief Kamailio core :: Receive msg function
30
+* \ingroup core
31
+* Module: \ref core
32
+*/
27 33
 
28 34
 
29 35
 
... ...
@@ -1,23 +1,16 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * resolver related functions
5 3
  *
6 4
  * Copyright (C) 2001-2003 FhG Fokus
7 5
  *
8
- * This file is part of ser, a free SIP server.
6
+ * This file is part of Kamailio, a free SIP server.
9 7
  *
10
- * ser is free software; you can redistribute it and/or modify
8
+ * Kamailio is free software; you can redistribute it and/or modify
11 9
  * it under the terms of the GNU General Public License as published by
12 10
  * the Free Software Foundation; either version 2 of the License, or
13 11
  * (at your option) any later version
14 12
  *
15
- * For a license to use the ser software under conditions
16
- * other than those described here, or to purchase support for this
17
- * software, please contact iptel.org by e-mail at the following addresses:
18
- *    info@iptel.org
19
- *
20
- * ser is distributed in the hope that it will be useful,
13
+ * Kamailio is distributed in the hope that it will be useful,
21 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 16
  * GNU General Public License for more details.
... ...
@@ -26,17 +19,14 @@
26 26
  * along with this program; if not, write to the Free Software 
27 27
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28 28
  */
29
-/* History:
30
- * --------
31
- *  2003-04-12  support for resolving ipv6 address references added (andrei)
32
- *  2004-07-28  darwin needs nameser_compat.h (andrei)
33
- *  2006-07-13  rdata structures put on diet (andrei)
34
- *  2006-07-17  rdata contains now also the record name (andrei)
35
- *  2006-08-18  get_record uses flags (andrei)
36
- *  2006-06-16  naptr support (andrei)
37
- */
38
-
39 29
 
30
+/*!
31
+ * \file
32
+ * \brief Kamailio core :: DNS resolver
33
+ * \author andrei
34
+ * \ingroup core
35
+ * Module: \ref core
36
+ */
40 37
 
41 38
 #ifndef __resolve_h
42 39
 #define __resolve_h
... ...
@@ -1,21 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
7 5
  *
8
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
9 7
  * it under the terms of the GNU General Public License as published by
10 8
  * the Free Software Foundation; either version 2 of the License, or
11 9
  * (at your option) any later version
12 10
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
19 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 14
  * GNU General Public License for more details.
... ...
@@ -24,6 +17,12 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
26 26
  */
27
+/*!
28
+* \file
29
+* \brief Kamailio core :: Message routing
30
+* \ingroup core
31
+* Module: \ref core
32
+*/
27 33
 
28 34
 
29 35
 #ifndef route_h
... ...
@@ -1,22 +1,14 @@
1 1
 /*
2
- * $Id$
3
- *
4
- *
5 2
  * Copyright (C) 2001-2003 FhG Fokus
6 3
  *
7
- * This file is part of ser, a free SIP server.
4
+ * This file is part of Kamailio, a free SIP server.
8 5
  *
9
- * ser is free software; you can redistribute it and/or modify
6
+ * Kamailio is free software; you can redistribute it and/or modify
10 7
  * it under the terms of the GNU General Public License as published by
11 8
  * the Free Software Foundation; either version 2 of the License, or
12 9
  * (at your option) any later version
13 10
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19
- * ser is distributed in the hope that it will be useful,
11
+ * Kamailio is distributed in the hope that it will be useful,
20 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 14
  * GNU General Public License for more details.
... ...
@@ -25,20 +17,14 @@
25 25
  * along with this program; if not, write to the Free Software
26 26
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
27 27
  */
28
-/* History:
29
- * --------
30
- *
31
- *  2003-04-12  FORCE_RPORT_T added (andrei)
32
- *  2003-04-22  strip_tail added (jiri)
33
- *  2003-10-10  >,<,>=,<=, != and MSGLEN_O added (andrei)
34
- *  2003-10-28  FORCE_TCP_ALIAS added (andrei)
35
- *  2004-02-24  added LOAD_AVP_T and AVP_TO_URI_T (bogdan)
36
- *  2005-12-11  added SND{IP,PORT,PROTO,AF}_O & TO{IP,PORT}_O (andrei)
37
- *  2005-12-19  select framework added SELECT_O and SELECT_ST (mma)
38
- *  2008-12-17  added UDP_MTU_TRY_PROTO_T (andrei)
28
+/*!
29
+ * \file
30
+ * \brief Kamailio core :: Route structure
31
+ * \ingroup core
32
+ * Module: \ref core
33
+ * \author andrei, bogdan
39 34
  */
40 35
 
41
-
42 36
 #ifndef route_struct_h
43 37
 #define route_struct_h
44 38
 
... ...
@@ -1,22 +1,16 @@
1
-/* $Id$
2
- *
3
- * SER Remote Procedure Call Interface
1
+/* 
2
+ * Kamailio Remote Procedure Call Interface
4 3
  *
5 4
  * Copyright (C) 2005 iptelorg GmbH
6 5
  *
7
- * This file is part of ser, a free SIP server.
6
+ * This file is part of Kamailio, a free SIP server.
8 7
  *
9
- * ser is free software; you can redistribute it and/or modify
8
+ * Kamailio is free software; you can redistribute it and/or modify
10 9
  * it under the terms of the GNU General Public License as published by
11 10
  * the Free Software Foundation; either version 2 of the License, or
12 11
  * (at your option) any later version
13 12
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19
- * ser is distributed in the hope that it will be useful,
13
+ * Kamailio is distributed in the hope that it will be useful,
20 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 16
  * GNU General Public License for more details.
... ...
@@ -26,6 +20,13 @@
26 26
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
27 27
  */
28 28
 
29
+/*!
30
+* \file
31
+* \brief Kamailio core :: RPC, Remote procedure call interface
32
+* \ingroup core
33
+* Module: \ref core
34
+*/
35
+
29 36
 #ifndef _RPC_H
30 37
 #define _RPC_H
31 38
 
... ...
@@ -46,15 +47,15 @@ struct rpc_delayed_ctx;
46 46
 
47 47
 
48 48
 /* Send the result to the caller */
49
-typedef int (*rpc_send_f)(void* ctx);                                      /* Send the reply to the client */
50
-typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /* Signal a failure to the client */
51
-typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /* Add a new piece of data to the result */
52
-typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /* Retrieve request parameters */
53
-typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /* Add printf-like formated data to the result set */
54
-typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /* Add fields in a structure */
55
-typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /* Add values in an array */
56
-typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /* Scan attributes of a structure */
57
-typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */
49
+typedef int (*rpc_send_f)(void* ctx);                                      /*!< Send the reply to the client */
50
+typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /*!< Signal a failure to the client */
51
+typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /*!< Add a new piece of data to the result */
52
+typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /*!< Retrieve request parameters */
53
+typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /*!< Add printf-like formated data to the result set */
54
+typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /*!< Add fields in a structure */
55
+typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /*!< Add values in an array */
56
+typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /*!< Scan attributes of a structure */
57
+typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /*!< Struct version of rpc_printf */
58 58
 
59 59
 /* returns the supported capabilities */
60 60
 typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx);
... ...
@@ -91,13 +92,12 @@ typedef struct rpc_delayed_ctx{
91 91
 } rpc_delayed_ctx_t;
92 92
 
93 93
 
94
-/*
94
+/**
95 95
  * RPC Function Prototype
96 96
  */
97
-
98 97
 typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx);
99 98
 
100
-/*
99
+/**
101 100
  * RPC callback context.
102 101
  *
103 102
  * Defines a convenient way of packing an rpc callback
... ...
@@ -110,14 +110,14 @@ typedef struct rpc_cb_ctx {
110 110
 } rpc_cb_ctx_t;
111 111
 
112 112
 
113
-/*
113
+/**
114 114
  * Remote Procedure Call Export
115 115
  */
116 116
 typedef struct rpc_export {
117
-	const char* name;        /* Name of the RPC function (null terminated) */
118
-	rpc_function_t function; /* Pointer to the function */
119
-	const char** doc_str;  /* Documentation strings, method signature and description */
120
-	unsigned int flags;      /* Various flags, reserved for future use */
117
+	const char* name;        /*!< Name of the RPC function (null terminated) */
118
+	rpc_function_t function; /*!< Pointer to the function */
119
+	const char** doc_str;  /*!< Documentation strings, method signature and description */
120
+	unsigned int flags;      /*!< Various flags, reserved for future use */
121 121
 } rpc_export_t;
122 122
 
123 123
 
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- * 
4 2
  * Copyright (C) 2009 iptelorg GmbH
5 3
  *
6 4
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -15,14 +13,13 @@
15 15
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 16
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 17
  */
18
-/*
19
- * SER RPC lookup and register functions
18
+/*!
19
+ * \file
20
+ * \brief Kamailio core :: Kamailio RPC lookup and register functions
21
+ * \ingroup core
22
+ * Module: \ref core
23
+ * \author andrei
20 24
  */
21
-/*
22
- * History:
23
- * --------
24
- *  2009-05-11  initial version (andrei)
25
-*/
26 25
 
27 26
 #ifndef __rpc_lookup_h
28 27
 #define __rpc_lookup_h
... ...
@@ -19,18 +19,9 @@
19 19
  * @brief SIP-router core :: rvalue expressions
20 20
  * @ingroup core
21 21
  * Module: \ref core
22
+ * @author andrei
22 23
  */
23 24
  
24
-/* 
25
- * History:
26
- * --------
27
- *  2008-11-30  initial version (andrei)
28
- *  2009-04-28  added string and interger versions for the EQ and DIFF
29
- *              operators (andrei)
30
- *  2009-05-05  casts operator for int & string (andrei)
31
- *  2010-03-16  space for an int2str result inside rval_cache (andrei)
32
- */
33
-
34 25
 #ifndef _rvalue_h_
35 26
 #define _rvalue_h_
36 27
 
... ...
@@ -1,10 +1,6 @@
1 1
 /*
2 2
  * sched_yield wrapper
3 3
  *
4
- * $Id$
5
- *
6
- * 
7
- *
8 4
  * Copyright (C) 2001-2003 FhG Fokus
9 5
  *
10 6
  * Permission to use, copy, modify, and distribute this software for any
... ...
@@ -19,14 +15,14 @@
19 19
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20 20
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 21
  */
22
-/*
23
- *
24
- *History:
25
- *--------
26
- *  2007-07-13  splitted from fastlock.h (andrei)
22
+/*!
23
+ * \file
24
+ * \brief Kamailio core :: Sched_yield wrapper
25