Przeglądaj źródła

- 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 17 lat temu
rodzic
commit
a103c1a10a

+ 1 - 1
modules/carrierroute/cr_db.c

@@ -21,7 +21,7 @@
  */
 
 /**
- * \file route_db.c
+ * \file cr_db.c
  * \brief Functions for loading routing data from a database.
  * \ingroup carrierroute
  * - Module; \ref carrierroute

+ 1 - 1
modules/carrierroute/cr_domain.c

@@ -183,7 +183,7 @@ int add_route_to_tree(struct dtrie_node_t *node, const str * scan_prefix,
  * the information is and the next_domain parameters defines where to continue
  * routing in case of a match.
  *
- * @param failure_tree the root of the failure routing tree
+ * @param failure_node the root of the failure routing tree
  * @param scan_prefix the prefix for which to add the rule (must not contain non-digits)
  * @param full_prefix the whole scan prefix
  * @param host the hostname last tried

+ 1 - 1
modules/carrierroute/cr_domain.h

@@ -111,7 +111,7 @@ int add_route_to_tree(struct dtrie_node_t *node, const str * scan_prefix,
  * the information is and the next_domain parameters defines where to continue
  * routing in case of a match.
  *
- * @param failure_tree the root of the failure routing tree
+ * @param failure_node the root of the failure routing tree
  * @param scan_prefix the prefix for which to add the rule (must not contain non-digits)
  * @param full_prefix the whole scan prefix
  * @param host the hostname last tried

+ 2 - 2
modules/carrierroute/cr_fifo.c

@@ -391,7 +391,7 @@ struct mi_root* delete_host (struct mi_root* cmd_tree, void * param) {
  * and prints route rules if present.
  *
  * @param msg MI node that is used to append the informations
- * @param tree pointer to the routing tree node
+ * @param node pointer to the routing tree node
  * @param prefix carries the current scan prefix
  *
  * @return mi node containing the route rules
@@ -719,7 +719,7 @@ errout:
  * Does the work for update_route_data by recursively
  * traversing the routing tree
  *
- * @param rt points to the current routing tree node
+ * @param node points to the current routing tree node
  * @param act_domain routing domain which is currently
  * searched
  * @param opts points to the fifo command option structure

+ 4 - 3
modules/carrierroute/cr_func.c

@@ -68,7 +68,8 @@ static const str AT_SIGN  = { .s="@",     .len=1 };
  * search_id function for the lookup.
  * @param _msg SIP message
  * @param gp id as integer, pseudo-variable or AVP name of carrier
- * @param search_if lookup function
+ * @param map lookup function
+ * @param size size of the list
  * @return id on success, -1 otherwise
  */
 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) {
 /**
  * writes the next_domain avp using the rule list of failure_tree
  *
- * @param failure_tree the head of the failure route rule list
+ * @param frr_head the head of the failure route rule list
  * @param host last tried host
  * @param reply_code the last reply code
  * @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,
  * The longest match is taken, so it is possible to define
  * failure route rules for a single number
  *
- * @param failure_tree the current routing tree node
+ * @param failure_node the current routing tree node
  * @param uri the uri to be rewritten at the current position
  * @param host last tried host
  * @param reply_code the last reply code

+ 1 - 1
modules/carrierroute/cr_rule.c

@@ -395,7 +395,7 @@ mem_error:
 /**
  * Destroys failure route rule frr by freeing all its memory.
  *
- * @param rr route rule to be destroyed
+ * @param frr route rule to be destroyed
  */
 void destroy_failure_route_rule(struct failure_route_rule * frr) {
 	if (frr->host.s) {

+ 1 - 1
modules/carrierroute/cr_rule.h

@@ -182,7 +182,7 @@ struct failure_route_rule *add_failure_route_rule(struct failure_route_rule **fr
 /**
  * Destroys failure route rule frr by freeing all its memory.
  *
- * @param rr route rule to be destroyed
+ * @param frr route rule to be destroyed
  */
 void destroy_failure_route_rule(struct failure_route_rule * frr);