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 7 changed files
... ...
@@ -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