From 87e4550585c643e97e0003119b254251ac5ed1d4 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 20 Jun 2017 00:17:59 +0200 Subject: 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 --- src/conv.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/conv.c') diff --git a/src/conv.c b/src/conv.c index b81e37ef..38ce173a 100644 --- a/src/conv.c +++ b/src/conv.c @@ -24,7 +24,7 @@ /*! \addtogroup conv * @{ - * \brief Osmocom convolutional encoder and decoder + * Osmocom convolutional encoder and decoder */ /*! \file conv.c */ @@ -78,7 +78,7 @@ osmo_conv_get_output_length(const struct osmo_conv_code *code, int len) /* Encoding */ /* ------------------------------------------------------------------------ */ -/*! \brief Initialize a convolutional encoder +/*! Initialize a convolutional encoder * \param[in,out] encoder Encoder state to initialize * \param[in] code Description of convolutional code */ @@ -198,7 +198,7 @@ osmo_conv_encode_flush(struct osmo_conv_encoder *encoder, return o_idx; } -/*! \brief All-in-one convolutional encoding function +/*! All-in-one convolutional encoding function * \param[in] code description of convolutional code to be used * \param[in] input array of unpacked bits (uncoded) * \param[out] output array of unpacked bits (encoded) @@ -593,7 +593,7 @@ osmo_conv_decode_get_output(struct osmo_conv_decoder *decoder, return min_ae; } -/*! \brief All-in-one convolutional decoding function +/*! All-in-one convolutional decoding function * \param[in] code description of convolutional code to be used * \param[in] input array of soft bits (coded) * \param[out] output array of unpacked bits (decoded) -- cgit v1.2.3