Browse code

- fix a bunch of doxygen errors (mostly in modules, some in the core) - credits belongs to Frederick Bullik, frederick dot bullik at 1und1 dot de

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5299 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 04/12/2008 18:12:33
Showing 30 changed files
... ...
@@ -27,7 +27,6 @@
27 27
  * \ingroup acc
28 28
  * \brief Acc:: Diameter support
29 29
  *
30
- * - \ref diam_dict.c
31 30
  * - Module: \ref acc
32 31
  */
33 32
 
... ...
@@ -487,7 +487,7 @@ int pv_proxy_authorize(struct sip_msg* msg, char* realm, char* str2)
487 487
 /*!
488 488
  * \brief Small wrapper around pv_authorize, use www challenge
489 489
  * \param msg SIP message
490
- * \param ream authenfication realm
490
+ * \param realm authenfication realm
491 491
  * \param str2 unused
492 492
  * \return 1 on sucess, 0 on errors, negative on authentification failures
493 493
  */
... ...
@@ -81,7 +81,7 @@ static str auth_500_err = str_init(MESSAGE_500);
81 81
 /*!
82 82
  * \brief Create {WWW,Proxy}-Authenticate header field
83 83
  * \param _stale
84
- * \param _real authentification realm
84
+ * \param _realm authentification realm
85 85
  * \param _len length, will be set
86 86
  * \param _qop qop value
87 87
  * \param _hf_name header field name
... ...
@@ -134,7 +134,7 @@ void calc_nonce(char* _nonce, int _expires, int _index, str* _secret)
134 134
 
135 135
 /*!
136 136
  * \brief Get index from nonce string
137
- * \param _nonce nonce string
137
+ * \param _n nonce string
138 138
  * \return nonce index
139 139
  */
140 140
 int get_nonce_index(str* _n)
... ...
@@ -145,7 +145,7 @@ int get_nonce_index(str* _n)
145 145
 
146 146
 /*!
147 147
  * \brief Get expiry time from nonce string
148
- * \param _nonce nonce string
148
+ * \param _n nonce string
149 149
  * \return expiry time
150 150
  */
151 151
 static inline time_t get_nonce_expires(str* _n)
... ...
@@ -62,7 +62,7 @@ int check_nonce(str* _nonce, str* _secret);
62 62
 
63 63
 /*!
64 64
  * \brief Get index from nonce string
65
- * \param _nonce nonce string
65
+ * \param _n nonce string
66 66
  * \return nonce index
67 67
  */
68 68
 int get_nonce_index(str* _nonce);
... ...
@@ -109,6 +109,7 @@ void calc_HA1(ha_alg_t _alg, str* _username, str* _realm, str* _password,
109 109
  * \param _ha1 H(A1)
110 110
  * \param _nonce nonce from server
111 111
  * \param _nc 8 hex digits
112
+ * \param _cnonce cnonce value
112 113
  * \param _qop qop-value: "", "auth", "auth-int
113 114
  * \param _auth_int  1 if auth-int is used
114 115
  * \param _method method from the request
... ...
@@ -76,6 +76,7 @@ void calc_HA1(ha_alg_t _alg, str* _username, str* _realm,
76 76
  * \param _ha1 H(A1)
77 77
  * \param _nonce nonce from server
78 78
  * \param _nc 8 hex digits
79
+ * \param _cnonce
79 80
  * \param _qop qop-value: "", "auth", "auth-int
80 81
  * \param _auth_int  1 if auth-int is used
81 82
  * \param _method method from the request
... ...
@@ -21,7 +21,7 @@
21 21
  */
22 22
 
23 23
 /**
24
- * \file route_db.c
24
+ * \file cr_db.c
25 25
  * \brief Functions for loading routing data from a database.
26 26
  * \ingroup carrierroute
27 27
  * - Module; \ref carrierroute
... ...
@@ -183,7 +183,7 @@ int add_route_to_tree(struct dtrie_node_t *node, const str * scan_prefix,
183 183
  * the information is and the next_domain parameters defines where to continue
184 184
  * routing in case of a match.
185 185
  *
186
- * @param failure_tree the root of the failure routing tree
186
+ * @param failure_node the root of the failure routing tree
187 187
  * @param scan_prefix the prefix for which to add the rule (must not contain non-digits)
188 188
  * @param full_prefix the whole scan prefix
189 189
  * @param host the hostname last tried
... ...
@@ -111,7 +111,7 @@ int add_route_to_tree(struct dtrie_node_t *node, const str * scan_prefix,
111 111
  * the information is and the next_domain parameters defines where to continue
112 112
  * routing in case of a match.
113 113
  *
114
- * @param failure_tree the root of the failure routing tree
114
+ * @param failure_node the root of the failure routing tree
115 115
  * @param scan_prefix the prefix for which to add the rule (must not contain non-digits)
116 116
  * @param full_prefix the whole scan prefix
117 117
  * @param host the hostname last tried
... ...
@@ -391,7 +391,7 @@ struct mi_root* delete_host (struct mi_root* cmd_tree, void * param) {
391 391
  * and prints route rules if present.
392 392
  *
393 393
  * @param msg MI node that is used to append the informations
394
- * @param tree pointer to the routing tree node
394
+ * @param node pointer to the routing tree node
395 395
  * @param prefix carries the current scan prefix
396 396
  *
397 397
  * @return mi node containing the route rules
... ...
@@ -719,7 +719,7 @@ errout:
719 719
  * Does the work for update_route_data by recursively
720 720
  * traversing the routing tree
721 721
  *
722
- * @param rt points to the current routing tree node
722
+ * @param node points to the current routing tree node
723 723
  * @param act_domain routing domain which is currently
724 724
  * searched
725 725
  * @param opts points to the fifo command option structure
... ...
@@ -68,7 +68,8 @@ static const str AT_SIGN  = { .s="@",     .len=1 };
68 68
  * search_id function for the lookup.
69 69
  * @param _msg SIP message
70 70
  * @param gp id as integer, pseudo-variable or AVP name of carrier
71
- * @param search_if lookup function
71
+ * @param map lookup function
72
+ * @param size size of the list
72 73
  * @return id on success, -1 otherwise
73 74
  */
74 75
 static inline int cr_gp2id(struct sip_msg *_msg, gparam_t *gp, struct name_map_t *map, int size) {
... ...
@@ -149,7 +150,7 @@ static inline int reply_code_matcher(const str *rcw, const str *rc) {
149 150
 /**
150 151
  * writes the next_domain avp using the rule list of failure_tree
151 152
  *
152
- * @param failure_tree the head of the failure route rule list
153
+ * @param frr_head the head of the failure route rule list
153 154
  * @param host last tried host
154 155
  * @param reply_code the last reply code
155 156
  * @param flags flags for the failure route rule
... ...
@@ -199,7 +200,7 @@ static int set_next_domain_on_rule(struct failure_route_rule *frr_head,
199 200
  * The longest match is taken, so it is possible to define
200 201
  * failure route rules for a single number
201 202
  *
202
- * @param failure_tree the current routing tree node
203
+ * @param failure_node the current routing tree node
203 204
  * @param uri the uri to be rewritten at the current position
204 205
  * @param host last tried host
205 206
  * @param reply_code the last reply code
... ...
@@ -395,7 +395,7 @@ mem_error:
395 395
 /**
396 396
  * Destroys failure route rule frr by freeing all its memory.
397 397
  *
398
- * @param rr route rule to be destroyed
398
+ * @param frr route rule to be destroyed
399 399
  */
400 400
 void destroy_failure_route_rule(struct failure_route_rule * frr) {
401 401
 	if (frr->host.s) {
... ...
@@ -182,7 +182,7 @@ struct failure_route_rule *add_failure_route_rule(struct failure_route_rule **fr
182 182
 /**
183 183
  * Destroys failure route rule frr by freeing all its memory.
184 184
  *
185
- * @param rr route rule to be destroyed
185
+ * @param frr route rule to be destroyed
186 186
  */
187 187
 void destroy_failure_route_rule(struct failure_route_rule * frr);
188 188
 
... ...
@@ -107,7 +107,7 @@ void db_postgres_close(db_con_t* _h)
107 107
 
108 108
 /*!
109 109
  * \brief Submit_query, run a query
110
- * \param _h database connection
110
+ * \param _con database connection
111 111
  * \param _s query string
112 112
  * \return 0 on success, negative on failure
113 113
  */
... ...
@@ -296,7 +296,7 @@ int db_postgres_fetch_result(const db_con_t* _con, db_res_t** _res, const int nr
296 296
 
297 297
 /*!
298 298
  * \brief Free database and any old query results
299
- * \param _h database connection
299
+ * \param _con database connection
300 300
  */
301 301
 static void free_query(const db_con_t* _con)
302 302
 {
... ...
@@ -332,7 +332,7 @@ int db_postgres_free_result(db_con_t* _con, db_res_t* _r)
332 332
 
333 333
 /*!
334 334
  * \brief Query table for specified rows
335
- * \param _con structure representing database connection
335
+ * \param _h structure representing database connection
336 336
  * \param _k key names
337 337
  * \param _op operators
338 338
  * \param _v values of the keys that must match
... ...
@@ -340,6 +340,7 @@ int db_postgres_free_result(db_con_t* _con, db_res_t* _r)
340 340
  * \param _n nmber of key=values pairs to compare
341 341
  * \param _nc number of columns to return
342 342
  * \param _o order by the specified column
343
+ * \param _r result set
343 344
  * \return 0 on success, negative on failure
344 345
  */
345 346
 int db_postgres_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op,
... ...
@@ -241,7 +241,7 @@ static void destroy(void)
241 241
  *
242 242
  * Convert a header field description string to hdr_field structure
243 243
  * Supported strings: "Request-URI", "To", "From", "Credentials"
244
- * \param header field description string
244
+ * \param str1 header field description string
245 245
  * \return hdr_field structure on success, NULL on failure
246 246
  */
247 247
 static group_check_p get_hf( char *str1)
... ...
@@ -455,9 +455,9 @@ static int fixup_presence(void** param, int param_no)
455 455
 
456 456
 /*! \brief
457 457
  *  mi cmd: refreshWatchers
458
- *			<presentity_uri> 
459
- *			<event>
460
- *          <refresh_type> // can be:  = 0 -> watchers autentification type or
458
+ *			\<presentity_uri> 
459
+ *			\<event>
460
+ *          \<refresh_type> // can be:  = 0 -> watchers autentification type or
461 461
  *									  != 0 -> publish type //		   
462 462
  *		* */
463 463
 
... ...
@@ -826,6 +826,7 @@ static int pipe_push(struct sip_msg * msg, int id)
826 826
 
827 827
 /**     
828 828
  * runs the current request through the queues
829
+ * \param       msg
829 830
  * \param       forced_pipe     is >= 0 if a specific pipe should be used, < 0 otherwise
830 831
  * \return	-1 if drop needed, 1 if allowed
831 832
  */
... ...
@@ -47,7 +47,7 @@
47 47
 #include "../../mem/mem.h"
48 48
 
49 49
 /*!
50
- * This function copies an OpenSER "str" datatype into a '\0' terminated char*
50
+ * This function copies an OpenSER "str" datatype into a '\\0' terminated char*
51 51
  * string. 
52 52
  *
53 53
  * \note Make sure to free the memory allocated to *copiedString, when you no
... ...
@@ -47,7 +47,7 @@
47 47
 #include "../../sr_module.h"
48 48
 
49 49
 /*!
50
- * This function copies an OpenSER "str" datatype into a '\0' terminated char*
50
+ * This function copies an OpenSER "str" datatype into a '\\0' terminated char*
51 51
  * string. 
52 52
  *
53 53
  * \note Make sure to free the memory allocated to *copiedString, when you no
... ...
@@ -44,9 +44,9 @@
44 44
 #define CALLID_NR_LEN 20
45 45
 
46 46
 /*! \brief
47
- *  Call-ID has the following form: <callid_nr>-<pid>@<ip>
47
+ *  Call-ID has the following form: \<callid_nr>-\<pid>\@\<ip>
48 48
  * callid_nr is initialized as a random number and continually
49
- * increases; -<pid>@<ip> is kept in callid_suffix
49
+ * increases; -\<pid>\@\<ip> is kept in callid_suffix
50 50
  */
51 51
 #define CALLID_SUFFIX_LEN ( 1 /*!< - */                                            + \
52 52
 			    5 /*!< pid */                                          + \
... ...
@@ -331,9 +331,9 @@ static inline int get_callid(struct sip_msg* _m, str* _cid)
331 331
 /*!
332 332
  * \brief Create a copy of route set either in normal or reverse order
333 333
  * \param _m SIP message
334
- * \param rr_t Route set
334
+ * \param _rs Route set
335 335
  * \param _order how to order the copy, set to NORMAL_ORDER for normal copy
336
- * \param 0 on success, -1 on error
336
+ * \return 0 on success, -1 on error
337 337
  */
338 338
 static inline int get_route_set(struct sip_msg* _m, rr_t** _rs, unsigned char _order)
339 339
 {
... ...
@@ -635,7 +635,7 @@ int dlg_response_uac(dlg_t* _d, struct sip_msg* _m)
635 635
  * \note Does not parse headers!
636 636
  * \param _m SIP message
637 637
  * \param _cs CSeq number
638
- * \param 0 on success, negative on error
638
+ * \return 0 on success, negative on error
639 639
  */
640 640
 static inline int get_cseq_value(struct sip_msg* _m, unsigned int* _cs)
641 641
 {
... ...
@@ -154,6 +154,7 @@ static inline struct str_list *new_str(char *s, int len, struct str_list **last,
154 154
  * pkg_mem.
155 155
  * \param uri SIP URI
156 156
  * \param hf header field
157
+ * \param l
157 158
  * \param send_sock socket information
158 159
  * \return new allocated char array on success, zero otherwise
159 160
  */
... ...
@@ -134,6 +134,7 @@ int insert_tmcb(struct tmcb_head_list *cb_list, int types,
134 134
  * (global or per transaction, depending of event type).
135 135
  * \param p_msg SIP message
136 136
  * \param t transaction
137
+ * \param types
137 138
  * \param f callback
138 139
  * \param param callback parameter
139 140
  * \return negative result on error, the return code from insert_tmcb on success
... ...
@@ -97,7 +97,7 @@ struct cell;
97 97
  *  or proxied) -- there is nothing more you can change from
98 98
  *  the callback, it is good for accounting-like uses.
99 99
  *
100
- *    Note: the message passed to callback may also have
100
+ *    \note: the message passed to callback may also have
101 101
  *    value FAKED_REPLY (like other reply callbacks) which
102 102
  *    indicates a pseudo_reply caused by a timer. Check for
103 103
  *    this value before deferring -- you will cause a segfault
... ...
@@ -128,13 +128,13 @@ struct cell;
128 128
  *  has not been executed and may fail, there is no guarantee
129 129
  *  a reply will be successfully sent out at this point of time.
130 130
  *
131
- *     \Note: TMCB_REPLY_ON_FAILURE and TMCB_REPLY_FWDED are
131
+ *     \note: TMCB_REPLY_ON_FAILURE and TMCB_REPLY_FWDED are
132 132
  *     called from reply mutex which is used to deterministically
133 133
  *     process multiple replies received in parallel. A failure
134 134
  *     to set the mutex again or stay too long in the callback
135 135
  *     may result in deadlock.
136 136
  *
137
- *     \Note: the reply callbacks will not be evoked if "silent
137
+ *     \note: the reply callbacks will not be evoked if "silent
138 138
  *     C-timer hits". That's a feature to clean transactional
139 139
  *     state from a proxy quickly -- transactions will then
140 140
  *     complete statelessly. If you wish to disable this
... ...
@@ -222,6 +222,7 @@ void destroy_tmcb_lists(void);
222 222
  * (global or per transaction, depending of event type).
223 223
  * \param p_msg SIP message
224 224
  * \param t transaction
225
+ * \param types
225 226
  * \param f callback
226 227
  * \param param callback parameter
227 228
  * \return negative result on error, the return code from insert_tmcb on success
... ...
@@ -934,7 +934,7 @@ discard:
934 934
 
935 935
 /*!
936 936
  * \brief Retransmits the last sent inbound reply
937
- * \param p_msg request for which I want to retransmit an associated reply
937
+ * \param t request for which I want to retransmit an associated reply
938 938
  * \return 1 on succes, -1 on errors
939 939
  */
940 940
 int t_retransmit_reply( struct cell *t )
... ...
@@ -123,8 +123,8 @@ void t_on_reply( unsigned int go_to );
123 123
 unsigned int get_on_reply(void);
124 124
 
125 125
 /* Retransmits the last sent inbound reply.
126
- * Returns  -1 - error
127
- *           1 - OK
126
+ * \param t
127
+ * \return  -1 - error,  1 - OK
128 128
  */
129 129
 int t_retransmit_reply( struct cell *t );
130 130
 
... ...
@@ -140,7 +140,7 @@ void generate_fromtag(str* tag, str* callid)
140 140
  * \param to To URI
141 141
  * \param from From URI
142 142
  * \param dialog dialog state
143
- * \param return 0 if parameter are ok, negative on error
143
+ * \return 0 if parameter are ok, negative on error
144 144
  */
145 145
 static inline int check_params(str* method, str* to, str* from, dlg_t** dialog)
146 146
 {
... ...
@@ -220,6 +220,7 @@ static inline struct sip_msg* buf_to_sip_msg(char *buf, unsigned int len,
220 220
  * \brief Send a request using data from the dialog structure
221 221
  * \param method SIP method
222 222
  * \param headers SIP header
223
+ * \param body 
223 224
  * \param dialog dialog state
224 225
  * \param cb transaction callback
225 226
  * \param cbp transaction callback parameter
... ...
@@ -400,7 +401,7 @@ error2:
400 401
  * \param dialog dialog state
401 402
  * \param completion_cb transaction callback
402 403
  * \param cbp transaction callback parameter
403
- * \param 1 on success, negative on error
404
+ * \return 1 on success, negative on error
404 405
  */
405 406
 int req_within(str* method, str* headers, str* body, dlg_t* dialog,
406 407
 									transaction_cb completion_cb, void* cbp)
... ...
@@ -145,7 +145,7 @@ inline static struct proxy_l *uri2proxy( str *uri, int forced_proto )
145 145
  *
146 146
  * Convert a URI into a socket address. Create a temporary proxy.
147 147
  * \param uri input URI
148
- * \param su target structure
148
+ * \param to_su target structure
149 149
  * \param proto protocol
150 150
  * \return choosen protocol
151 151
  */
... ...
@@ -177,7 +177,7 @@ static inline int uri2su(str *uri, union sockaddr_union *to_su, int proto)
177 177
  * Convert a URI into a socket_info for sending.
178 178
  * \param msg SIP message
179 179
  * \param uri input URI
180
- * \param to_so socket address
180
+ * \param to_su socket address
181 181
  * \param proto protocol
182 182
  * \return send socket
183 183
  */
... ...
@@ -35,7 +35,7 @@
35 35
 #include "xmpp.h"
36 36
 #include "../../parser/parse_uri.h"
37 37
 
38
-/*! \brief decode sip:user*domain1@domain2 -> user@domain1 
38
+/*! \brief decode sip:user*domain1\@domain2 -> user\@domain1 
39 39
 	\note In many kinds of gateway scenarios, the % sign is a common character used
40 40
 		See the MSN XMPP transports for an example.
41 41
  */
... ...
@@ -61,7 +61,7 @@ char *decode_uri_sip_xmpp(char *uri)
61 61
 	return buf;
62 62
 }
63 63
 
64
-/*! \brief  encode sip:user@domain -> user*domain@xmpp_domain */
64
+/*! \brief  encode sip:user\@domain -> user*domain\@xmpp_domain */
65 65
 char *encode_uri_sip_xmpp(char *uri)
66 66
 {
67 67
 	struct sip_uri puri;
... ...
@@ -81,7 +81,7 @@ char *encode_uri_sip_xmpp(char *uri)
81 81
 	return buf;
82 82
 }
83 83
 
84
-/*! \brief  decode user*domain1@domain2 -> sip:user@domain1 */
84
+/*! \brief  decode user*domain1\@domain2 -> sip:user\@domain1 */
85 85
 char *decode_uri_xmpp_sip(char *jid)
86 86
 {
87 87
 	static char buf[512];
... ...
@@ -104,7 +104,7 @@ char *decode_uri_xmpp_sip(char *jid)
104 104
 	return buf;
105 105
 }
106 106
 
107
-/*! \brief  encode user@domain -> sip:user*domain@gateway_domain */
107
+/*! \brief  encode user\@domain -> sip:user*domain\@gateway_domain */
108 108
 char *encode_uri_xmpp_sip(char *jid)
109 109
 {
110 110
 	static char buf[512];