Change in libosmocore[master]: Doxygen: fix documentation of rate_ctr_for_each_counter()

Vadim Yanitskiy gerrit-no-reply at lists.osmocom.org
Mon Mar 25 18:09:53 UTC 2019


Vadim Yanitskiy has uploaded this change for review. ( https://gerrit.osmocom.org/13409


Change subject: Doxygen: fix documentation of rate_ctr_for_each_counter()
......................................................................

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
---
M include/osmocom/core/rate_ctr.h
M src/rate_ctr.c
2 files changed, 1 insertion(+), 5 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/09/13409/1

diff --git a/include/osmocom/core/rate_ctr.h b/include/osmocom/core/rate_ctr.h
index 865467c..f7e6e22 100644
--- a/include/osmocom/core/rate_ctr.h
+++ b/include/osmocom/core/rate_ctr.h
@@ -111,10 +111,6 @@
 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 c9319a6..82fddc6 100644
--- a/src/rate_ctr.c
+++ b/src/rate_ctr.c
@@ -385,7 +385,7 @@
 }
 
 /*! 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

-- 
To view, visit https://gerrit.osmocom.org/13409
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Icca2d4a95bd5f96ae85a86909ec90fb8677cacf3
Gerrit-Change-Number: 13409
Gerrit-PatchSet: 1
Gerrit-Owner: Vadim Yanitskiy <axilirator at gmail.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190325/cbf1ca0a/attachment.html>


More information about the gerrit-log mailing list