diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 00:17:59 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:22 +0000 |
| commit | 87e4550585c643e97e0003119b254251ac5ed1d4 (patch) | |
| tree | 9287f66aba70e9253f4d62926c54dddeb492895e /src/loggingrb.c | |
| parent | 249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff) | |
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for
every single API doc.
Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes
the first sentence of an API doc as the brief description.
Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'src/loggingrb.c')
| -rw-r--r-- | src/loggingrb.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/loggingrb.c b/src/loggingrb.c index 3fb38ca1..64033fc3 100644 --- a/src/loggingrb.c +++ b/src/loggingrb.c @@ -24,7 +24,7 @@ */ /*! \file loggingrb.c - * \brief libosmocore logging backend for a ring-buffer of last log messages + * libosmocore logging backend for a ring-buffer of last log messages */ #include <osmocom/core/strrb.h> @@ -37,7 +37,7 @@ static void _rb_output(struct log_target *target, osmo_strrb_add(target->tgt_rb.rb, log); } -/*! \brief Return the number of log strings in the osmo_strrb-backed target. +/*! Return the number of log strings in the osmo_strrb-backed target. * \param[in] target The target to search. * * \return The number of log strings in the osmo_strrb-backed target. @@ -47,7 +47,7 @@ size_t log_target_rb_used_size(struct log_target const *target) return osmo_strrb_elements(target->tgt_rb.rb); } -/*! \brief Return the capacity of the osmo_strrb-backed target. +/*! Return the capacity of the osmo_strrb-backed target. * \param[in] target The target to search. * * Note that this is the capacity (aka max number of messages). @@ -60,7 +60,7 @@ size_t log_target_rb_avail_size(struct log_target const *target) return rb->size - 1; } -/*! \brief Return the nth log entry in a target. +/*! Return the nth log entry in a target. * \param[in] target The target to search. * \param[in] logindex The index of the log entry/error message. * @@ -71,7 +71,7 @@ const char *log_target_rb_get(struct log_target const *target, size_t logindex) return osmo_strrb_get_nth(target->tgt_rb.rb, logindex); } -/*! \brief Create a new logging target for ringbuffer-backed logging. +/*! Create a new logging target for ringbuffer-backed logging. * \param[in] size The capacity (number of messages) of the logging target. * \returns A log target in case of success, NULL in case of error. */ |