diff options
author | Harald Welte <laforge@gnumonks.org> | 2016-04-25 12:11:20 +0200 |
---|---|---|
committer | Harald Welte <laforge@gnumonks.org> | 2016-05-05 18:49:27 +0200 |
commit | 2d2e2cca0dc1d62addc9c9fcb3a59f343fc3baf6 (patch) | |
tree | 8ec3ba89d486e4c324d32d1980ce68d5118d2db1 /include/osmocom/core/rate_ctr.h | |
parent | 0996c879255e4653740814112bf98d0ddc93100c (diff) |
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.
Diffstat (limited to 'include/osmocom/core/rate_ctr.h')
-rw-r--r-- | include/osmocom/core/rate_ctr.h | 7 |
1 files changed, 5 insertions, 2 deletions
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); |