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/ctrl | |
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/ctrl')
-rw-r--r-- | src/ctrl/control_if.c | 12 | ||||
-rw-r--r-- | src/ctrl/fsm_ctrl_commands.c | 2 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/ctrl/control_if.c b/src/ctrl/control_if.c index 5a84f7c0..5d04cdfd 100644 --- a/src/ctrl/control_if.c +++ b/src/ctrl/control_if.c @@ -126,7 +126,7 @@ int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd) return ret; } -/*! \brief Send TRAP over given Control Interface +/*! Send TRAP over given Control Interface * \param[in] ctrl Control Interface over which TRAP will be sent * \param[in] name Name of the TRAP variable * \param[in] value Value of the TRAP variable @@ -401,7 +401,7 @@ static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg) return rc; } -/*! \brief Allocate CTRL connection +/*! Allocate CTRL connection * \param[in] ctx Context from which talloc should allocate it * \param[in] data caller's private data parameter which should assigned to write queue's file descriptor data parameter. @@ -729,7 +729,7 @@ err: return -1; } -/*! \brief Allocate a CTRL interface handle +/*! Allocate a CTRL interface handle * \param[in] ctx Tallo callocation context to be used * \param[in] data Pointer which will be made available to each set_..() get_..() verify_..() control command function @@ -754,7 +754,7 @@ struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup loo return ctrl; } -/*! \brief Setup CTRL interface on a given address +/*! Setup CTRL interface on a given address * \param[in] data Pointer which will be made available to each set_..() get_..() verify_..() control command function * \param[in] bind_addr Address on which CTRL socket shall listen @@ -788,7 +788,7 @@ struct ctrl_handle *ctrl_interface_setup_dynip(void *data, return ctrl; } -/*! \brief Install a lookup helper function for control nodes +/*! Install a lookup helper function for control nodes * This function is used by e.g. library code to install lookup helpers * for additional nodes in the control interface. * \param[in] lookup The lookup helper function @@ -813,7 +813,7 @@ int ctrl_lookup_register(ctrl_cmd_lookup lookup) return 0; } -/*! \brief Helper for "local execution" of a CTRL command from a string +/*! Helper for "local execution" of a CTRL command from a string * The function will parse + execute the given control command string * and return a corresponding ctrl_cmd. Caller is responsible to * talloc_free() the return value. diff --git a/src/ctrl/fsm_ctrl_commands.c b/src/ctrl/fsm_ctrl_commands.c index 95d5fca6..6c3ecde1 100644 --- a/src/ctrl/fsm_ctrl_commands.c +++ b/src/ctrl/fsm_ctrl_commands.c @@ -6,7 +6,7 @@ #include <osmocom/ctrl/control_cmd.h> #include <osmocom/ctrl/control_if.h> -/*! \brief control interface lookup function for FSM's +/*! control interface lookup function for FSM's * \param[in] data Private data passed to controlif_setup() * \param[in] vline Vector of the line holding the command string * \param[out] node_type type (CTRL_NODE_) that was determined |