Browse code

doxygen documentation fixes

Henning Westerholt authored on 27/07/2011 22:22:09
Showing 12 changed files
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6 4
  * This file is part of ser, a free SIP server.
... ...
@@ -103,7 +101,7 @@
103 103
 	(log_level_info[(level) - (L_ALERT)].syslog_level)
104 104
 
105 105
 
106
-/** @brief my_pid(), process_no are from pt.h but we cannot #include it here
106
+/** @brief my_pid(), process_no are from pt.h but we cannot \#include it here
107 107
    because of circular dependencies */
108 108
 extern int process_no;
109 109
 extern int my_pid();
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2006 iptelorg GmbH
5 3
  *
6 4
  * This file is part of ser, a free SIP server.
... ...
@@ -94,7 +92,7 @@ void destroy_dst_blacklist();
94 94
 
95 95
 
96 96
 /** force add to the blacklist.
97
- * like @function dst_blacklist_add_to, but no ignore mask or
97
+ * like function dst_blacklist_add_to, but no ignore mask or
98 98
  * blacklist enabled checks are made.
99 99
  * @see dst_blacklist_add_to for the parameters and return value.
100 100
  */
... ...
@@ -102,7 +100,7 @@ int dst_blacklist_force_add_to(unsigned char err_flags, struct dest_info* si,
102 102
 								struct sip_msg* msg, ticks_t timeout);
103 103
 
104 104
 /** force add to the blacklist, long version.
105
- * like @function dst_blacklist_su_to, but no ignore mask or
105
+ * like function dst_blacklist_su_to, but no ignore mask or
106 106
  * blacklist enabled checks are made.
107 107
  * @see dst_blacklist_su_to for the parameters and return value.
108 108
  */
... ...
@@ -127,13 +125,12 @@ int dst_blacklist_force_su_to(	unsigned char err_flags,
127 127
 
128 128
 
129 129
 /** checks if blacklist should be used, long version.
130
-  * @param  err_flags - blacklist reason
130
+  * @param err_flags - blacklist reason
131 131
   * @param snd_flags - snd_flags pointer, can be 0.
132 132
   * @param proto - protocol, can be 0 (PROTO_NONE).
133
-  * @param si  - sockaddr_union pointer, can be 0.
133
+  * @param su  - sockaddr_union pointer, can be 0.
134 134
   * @return 1 if blacklist is enabled (core_cfg) and the event/error
135
-  *           is not in the ignore list.
136
-  *         0 otherwise
135
+  *           is not in the ignore list. 0 otherwise
137 136
   */
138 137
 #define should_blacklist_su(err_flags, snd_flags, proto, su) \
139 138
 	(cfg_get(core, core_cfg, use_dst_blacklist) && \
... ...
@@ -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,7 @@
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
- * @file mod_fix.c
20
- * @brief kamailio compatible fixups
21
- */
18
+
22 19
 /* 
23 20
  * History:
24 21
  * --------
... ...
@@ -27,7 +22,7 @@
27 27
 
28 28
 /*!
29 29
  * \file
30
- * \brief SIP-router core :: 
30
+ * \brief SIP-router core :: kamailio compatible fixups
31 31
  * \ingroup core
32 32
  * Module: \ref core
33 33
  */
... ...
@@ -67,7 +62,7 @@ int fixup_regexpNL_none(void** param, int param_no); /* textops */
67 67
   * @param maxp - maximum parameter number
68 68
   * @param no1 -  number of parameters of type1
69 69
   * @param type1 - fix_param type for the 1st param
70
-  * @paran type2 - fix_param type for all the other params
70
+  * @param type2 - fix_param type for all the other params
71 71
   */
72 72
 #define FIXUP_F2FP(suffix, minp, maxp, no1, type1, type2) \
73 73
 	int fixup_##suffix (void** param, int param_no) \
... ...
@@ -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
... ...
@@ -20,7 +18,6 @@
20 20
  * openssl BIOs for reading/writing via a fixed memory buffer.
21 21
  * @file
22 22
  * @ingroup tls
23
- * @Module: @ref tls
24 23
  */
25 24
 
26 25
 /*
... ...
@@ -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,11 +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
+ 
18 19
 /** openssl BIOs for reading/writing via a fixed memory buffer.
19 20
  * @file modules/tls/tls_bio.h
20 21
  * @ingroup tls
21
- * @Module: @ref tls
22 22
  */
23
+ 
23 24
 /*
24 25
  * History:
25 26
  * --------
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * presence module - presence server implementation
5 3
  *
6 4
  * Copyright (C) 2006 Voice Sistem S.R.L.
... ...
@@ -28,7 +26,6 @@
28 28
 
29 29
 /*! \file
30 30
  * \brief Kamailio presence module :: SUBSCRIBE support
31
- * \ref subscribe.c
32 31
  * \ingroup presence 
33 32
  */
34 33
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id: mi.h 4518 2008-07-28 15:39:28Z henningw $
3
- *
4 2
  * Header file for TM MI functions
5 3
  *
6 4
  * Copyright (C) 2006 Voice Sistem SRL
... ...
@@ -31,7 +29,6 @@
31 31
  *
32 32
  * \ingroup tm
33 33
  * - Module: \ref tm
34
- * - \ref mi.c
35 34
  */
36 35
 
37 36
 #ifndef _TM_MI_H_
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (c) 2004 Juha Heinanen
5 3
  *
6 4
  * This file is part of ser, a free SIP server.
... ...
@@ -39,9 +37,8 @@
39 39
 /*! \brief
40 40
  * This method is used to parse Allow header.
41 41
  *
42
- * \params  msg : sip msg
43
- * \return 0 on success,
44
- *        -1 on failure.
42
+ * \param hf message header field
43
+ * \return 0 on success, -1 on failure.
45 44
  */
46 45
 int parse_allow_header(struct hdr_field* _hf)
47 46
 {
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (c) 2004 Juha Heinanen
5 3
  *
6 4
  * This file is part of ser, a free SIP server.
... ...
@@ -56,7 +54,10 @@ int parse_allow(struct sip_msg *msg);
56 56
 
57 57
 
58 58
 /*! \brief
59
- * Parse Allow HF body
59
+ * This method is used to parse Allow header.
60
+ *
61
+ * \param hf message header field
62
+ * \return 0 on success, -1 on failure.
60 63
  */
61 64
 int parse_allow_header(struct hdr_field* _h);
62 65
 
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- *
4 2
  * Generic Parameter Parser
5 3
  *
6 4
  * Copyright (C) 2001-2003 FhG Fokus
... ...
@@ -503,14 +501,11 @@ error:
503 503
 
504 504
 /*! \brief
505 505
  * Parse parameters
506
- *  \param _s is string containing parameters, it will be updated to point behind the parameters
507
- *  \param _c is class of parameters
508
- *  \param _h is pointer to structure that will be filled with pointer to well known parameters
509
- *  \param the variable _p is pointing to
510
- * linked list of parsed parameters will be stored
511
- *
512
- * The function returns 0 on success and negative number
513
- * on an error
506
+ * \param _s is string containing parameters, it will be updated to point behind the parameters
507
+ * \param _c is class of parameters
508
+ * \param _h is pointer to structure that will be filled with pointer to well known parameters
509
+ * \param _p pointing to linked list where parsed parameters will be stored
510
+ * \return 0 on success and negative number on an error
514 511
  */
515 512
 int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p)
516 513
 {
... ...
@@ -1,6 +1,4 @@
1 1
 /* 
2
- * $Id$
3
- *
4 2
  * Generic Parameter Parser
5 3
  *
6 4
  * Copyright (C) 2001-2003 FhG Fokus
... ...
@@ -143,7 +141,7 @@ typedef union param_hooks {
143 143
 
144 144
 /*! \brief
145 145
  * Only parse one parameter
146
- * @Return:
146
+ * @return:
147 147
  * 	t: out parameter
148 148
  * 	-1: on error
149 149
  * 	0: success, but expect a next paramter
... ...
@@ -157,8 +155,7 @@ inline int parse_param(str *_s, pclass_t _c, param_hooks_t *_h, param_t *t);
157 157
  *  \param _s is string containing parameters
158 158
  *  \param _c is class of parameters
159 159
  *  \param _h is pointer to structure that will be filled with pointer to well known parameters
160
- * linked list of parsed parameters will be stored in
161
- * the variable _p is pointing to
160
+ * linked list of parsed parameters will be stored in the variable _p is pointing to
162 161
  * \return The function returns 0 on success and negative number
163 162
  * on an error
164 163
  */
... ...
@@ -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,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
+ 
18 19
 /**
19 20
  * @file 
20 21
  * @brief rvalue expressions
21 22
  */
23
+ 
22 24
 /* 
23 25
  * History:
24 26
  * --------