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
diff --git a/src/utils.c b/src/utils.c
index e7c6bcf..2bd4c19 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -33,14 +33,14 @@
/*! \addtogroup utils
* @{
- * \brief various utility routines
+ * various utility routines
*/
/*! \file utils.c */
static char namebuf[255];
-/*! \brief get human-readable string for given value
+/*! get human-readable string for given value
* \param[in] vs Array of value_string tuples
* \param[in] val Value to be converted
* \returns pointer to human-readable string
@@ -60,7 +60,7 @@
return namebuf;
}
-/*! \brief get human-readable string or NULL for given value
+/*! get human-readable string or NULL for given value
* \param[in] vs Array of value_string tuples
* \param[in] val Value to be converted
* \returns pointer to human-readable string or NULL if val is not found
@@ -80,7 +80,7 @@
return NULL;
}
-/*! \brief get numeric value for given human-readable string
+/*! get numeric value for given human-readable string
* \param[in] vs Array of value_string tuples
* \param[in] str human-readable string
* \returns numeric value (>0) or negative numer in case of error
@@ -98,7 +98,7 @@
return -EINVAL;
}
-/*! \brief Convert BCD-encoded digit into printable character
+/*! Convert BCD-encoded digit into printable character
* \param[in] bcd A single BCD-encoded digit
* \returns single printable character
*/
@@ -110,7 +110,7 @@
return 'A' + (bcd - 0xa);
}
-/*! \brief Convert number in ASCII to BCD value
+/*! Convert number in ASCII to BCD value
* \param[in] c ASCII character
* \returns BCD encoded value of character
*/
@@ -119,7 +119,7 @@
return c - 0x30;
}
-/*! \brief Parse a string containing hexadecimal digits
+/*! Parse a string containing hexadecimal digits
* \param[in] str string containing ASCII encoded hexadecimal digits
* \param[out] b output buffer
* \param[in] max_len maximum space in output buffer
@@ -194,7 +194,7 @@
return hexd_buff;
}
-/*! \brief Convert a sequence of unpacked bits to ASCII string
+/*! Convert a sequence of unpacked bits to ASCII string
* \param[in] bits A sequence of unpacked bits
* \param[in] len Length of bits
*/
@@ -228,7 +228,7 @@
return hexd_buff;
}
-/*! \brief Convert binary sequence to hexadecimal ASCII string
+/*! Convert binary sequence to hexadecimal ASCII string
* \param[in] buf pointer to sequence of bytes
* \param[in] len length of buf in number of bytes
* \returns pointer to zero-terminated string
@@ -241,7 +241,7 @@
return _osmo_hexdump(buf, len, " ");
}
-/*! \brief Convert binary sequence to hexadecimal ASCII string
+/*! Convert binary sequence to hexadecimal ASCII string
* \param[in] buf pointer to sequence of bytes
* \param[in] len length of buf in number of bytes
* \returns pointer to zero-terminated string
@@ -265,7 +265,7 @@
#include "../config.h"
#ifdef HAVE_CTYPE_H
#include <ctype.h>
-/*! \brief Convert an entire string to lower case
+/*! Convert an entire string to lower case
* \param[out] out output string, caller-allocated
* \param[in] in input string
*/
@@ -278,7 +278,7 @@
out[strlen(in)] = '\0';
}
-/*! \brief Convert an entire string to upper case
+/*! Convert an entire string to upper case
* \param[out] out output string, caller-allocated
* \param[in] in input string
*/
@@ -292,7 +292,7 @@
}
#endif /* HAVE_CTYPE_H */
-/*! \brief Wishful thinking to generate a constant time compare
+/*! Wishful thinking to generate a constant time compare
* \param[in] exp Expected data
* \param[in] rel Comparison value
* \param[in] count Number of bytes to compare
@@ -313,7 +313,7 @@
return x? 1 : 0;
}
-/*! \brief Generic retrieval of 1..8 bytes as big-endian uint64_t
+/*! Generic retrieval of 1..8 bytes as big-endian uint64_t
* \param[in] data Input data as byte-array
* \param[in] data_len Length of \a data in octets
* \returns uint64_t of \a data interpreted as big-endian
@@ -337,7 +337,7 @@
return value;
}
-/*! \brief Generic big-endian encoding of big endian number up to 64bit
+/*! Generic big-endian encoding of big endian number up to 64bit
* \param[in] value unsigned integer value to be stored
* \param[in] data_len number of octets
* \returns static buffer containing big-endian stored value
@@ -353,7 +353,7 @@
return buf;
}
-/*! \brief Copy a C-string into a sized buffer
+/*! Copy a C-string into a sized buffer
* \param[in] src source string
* \param[out] dst destination string
* \param[in] siz size of the \a dst buffer