summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVadim Yanitskiy <axilirator@gmail.com>2019-03-26 00:48:30 +0700
committerHarald Welte <laforge@gnumonks.org>2019-03-27 08:56:21 +0100
commitc761044ecb8572fb4cede10fcc64fac3db697f28 (patch)
tree8d2589db9f944135d984d91f0e636c49d3afd634
parent914a8ec5b3402f9d543e937595ef2440474fc168 (diff)
Doxygen: fix documentation of rate_ctr_for_each_counter()
Doxygen was confused by duplicated documentation for both definition and declaration of rate_ctr_for_each_counter(). Moreover, both variants contained some mistakes. Let's avoid this duplication and keep the only (corrected) one. Change-Id: Icca2d4a95bd5f96ae85a86909ec90fb8677cacf3
-rw-r--r--include/osmocom/core/rate_ctr.h4
-rw-r--r--src/rate_ctr.c2
2 files changed, 1 insertions, 5 deletions
diff --git a/include/osmocom/core/rate_ctr.h b/include/osmocom/core/rate_ctr.h
index 865467ce..f7e6e225 100644
--- a/include/osmocom/core/rate_ctr.h
+++ b/include/osmocom/core/rate_ctr.h
@@ -111,10 +111,6 @@ typedef int (*rate_ctr_handler_t)(
typedef int (*rate_ctr_group_handler_t)(struct rate_ctr_group *, void *);
-/*! Iterate over all counters
- * \param[in] handle_item Call-back function, aborts if rc < 0
- * \param[in] data Private data handed through to \a handle_counter
- */
int rate_ctr_for_each_counter(struct rate_ctr_group *ctrg,
rate_ctr_handler_t handle_counter, void *data);
diff --git a/src/rate_ctr.c b/src/rate_ctr.c
index c9319a6f..82fddc62 100644
--- a/src/rate_ctr.c
+++ b/src/rate_ctr.c
@@ -385,7 +385,7 @@ const struct rate_ctr *rate_ctr_get_by_name(const struct rate_ctr_group *ctrg, c
}
/*! Iterate over each counter in group and call function
- * \param[in] counter group over whose counter to iterate
+ * \param[in] ctrg counter group over which to iterate
* \param[in] handle_counter function pointer
* \param[in] data Data to hand transparently to \ref handle_counter
* \returns 0 on success; negative otherwise