From 2d2e2cca0dc1d62addc9c9fcb3a59f343fc3baf6 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 25 Apr 2016 12:11:20 +0200 Subject: Update doxygen annotations in libosmocore This adds and improves doxygen API descriptions all over libosmocore, reducing the 'white spots' that don't have any documentation. --- include/osmocom/core/rate_ctr.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'include/osmocom/core/rate_ctr.h') diff --git a/include/osmocom/core/rate_ctr.h b/include/osmocom/core/rate_ctr.h index cdde353a..ebaa7a71 100644 --- a/include/osmocom/core/rate_ctr.h +++ b/include/osmocom/core/rate_ctr.h @@ -78,10 +78,13 @@ static inline void rate_ctr_group_upd_idx(struct rate_ctr_group *grp, unsigned i void rate_ctr_group_free(struct rate_ctr_group *grp); -/*! \brief Increment the counter by \a inc */ +/*! \brief Increment the counter by \a inc + * \param ctr \ref rate_ctr to increment + * \param inc quantity to increment \a ctr by */ void rate_ctr_add(struct rate_ctr *ctr, int inc); -/*! \brief Increment the counter by 1 */ +/*! \brief Increment the counter by 1 + * \param ctr \ref rate_ctr to increment */ static inline void rate_ctr_inc(struct rate_ctr *ctr) { rate_ctr_add(ctr, 1); -- cgit v1.2.3