aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Erlbeck <jerlbeck@sysmocom.de>2015-10-19 15:00:59 +0200
committerJacob Erlbeck <jerlbeck@sysmocom.de>2015-10-28 23:53:45 +0100
commite5b0fe2e3c84dd0de7021d65d416356612db4260 (patch)
tree87708379e86749adf723eedba83426c53eaacb36
parentc6a7108828bf98ebcaf31d24bd8d789afdd4da94 (diff)
core: Update osmo_counters_for_each doc
Fix type and add a note about the semantics of the handler's return code. Sponsored-by: On-Waves ehf
-rw-r--r--include/osmocom/core/statistics.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/osmocom/core/statistics.h b/include/osmocom/core/statistics.h
index de250be..a9a623d 100644
--- a/include/osmocom/core/statistics.h
+++ b/include/osmocom/core/statistics.h
@@ -37,8 +37,8 @@ struct osmo_counter *osmo_counter_alloc(const char *name);
*/
void osmo_counter_free(struct osmo_counter *ctr);
-/*! \brief Iteate over all counters
- * \param[in] handle_counter Call-back function
+/*! \brief Iterate over all counters
+ * \param[in] handle_counter Call-back function, aborts if rc < 0
* \param[in] data Private dtata handed through to \a handle_counter
*/
int osmo_counters_for_each(int (*handle_counter)(struct osmo_counter *, void *), void *data);