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/crcXXgen.c.tpl | |
| 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/crcXXgen.c.tpl')
| -rw-r--r-- | src/crcXXgen.c.tpl | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/crcXXgen.c.tpl b/src/crcXXgen.c.tpl index 1a69e852..9c63052d 100644 --- a/src/crcXXgen.c.tpl +++ b/src/crcXXgen.c.tpl @@ -24,7 +24,7 @@ /*! \addtogroup crcgen * @{ - * \brief Osmocom generic CRC routines + * Osmocom generic CRC routines */ /*! \file crcXXgen.c @@ -37,7 +37,7 @@ #include <osmocom/core/crcXXgen.h> -/*! \brief Compute the CRC value of a given array of hard-bits +/*! Compute the CRC value of a given array of hard-bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits @@ -69,7 +69,7 @@ osmo_crcXXgen_compute_bits(const struct osmo_crcXXgen_code *code, } -/*! \brief Checks the CRC value of a given array of hard-bits +/*! Checks the CRC value of a given array of hard-bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits @@ -95,7 +95,7 @@ osmo_crcXXgen_check_bits(const struct osmo_crcXXgen_code *code, } -/*! \brief Computes and writes the CRC value of a given array of bits +/*! Computes and writes the CRC value of a given array of bits * \param[in] code The CRC code description to apply * \param[in] in Array of hard bits * \param[in] len Length of the array of hard bits |