commit e5b0fe2e3c84dd0de7021d65d416356612db4260
author Jacob Erlbeck <jerlbeck@sysmocom.de> Mon Oct 19 15:00:59 2015 +0200
committer Jacob Erlbeck <jerlbeck@sysmocom.de> Wed Oct 28 23:53:45 2015 +0100
tree 87708379e86749adf723eedba83426c53eaacb36
parent c6a7108828bf98ebcaf31d24bd8d789afdd4da94

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

include/osmocom/core/statistics.h

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 @@
  */
 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);