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/macaddr.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/macaddr.c') diff --git a/src/macaddr.c b/src/macaddr.c index e5db8cf0..6a1588d3 100644 --- a/src/macaddr.c +++ b/src/macaddr.c @@ -25,7 +25,7 @@ */ /*! \file macaddr.c - * \brief MAC address utility routines + * MAC address utility routines */ #include "config.h" @@ -35,7 +35,7 @@ #include #include -/*! \brief Parse a MAC address from human-readable notation +/*! Parse a MAC address from human-readable notation * This function parses an ethernet MAC address in the commonly-used * hex/colon notation (00:00:00:00:00:00) and generates the binary * representation from it. @@ -70,7 +70,7 @@ int osmo_macaddr_parse(uint8_t *out, const char *in) #include #include -/*! \brief Obtain the MAC address of a given network device +/*! Obtain the MAC address of a given network device * \param[out] mac_out pointer to caller-allocated buffer of 6 bytes * \param[in] dev_name string name of the network device * \returns 0 in case of success; negative otherwise @@ -114,7 +114,7 @@ int osmo_get_macaddr(uint8_t *mac_out, const char *dev_name) #include #include -/*! \brief Obtain the MAC address of a given network device +/*! Obtain the MAC address of a given network device * \param[out] mac_out pointer to caller-allocated buffer of 6 bytes * \param[in] dev_name string name of the network device * \returns 0 in case of success; negative otherwise -- cgit v1.2.3