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/vty/fsm_vty.c | |
| 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/vty/fsm_vty.c')
| -rw-r--r-- | src/vty/fsm_vty.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/vty/fsm_vty.c b/src/vty/fsm_vty.c index 3824fe8c..acc8ca60 100644 --- a/src/vty/fsm_vty.c +++ b/src/vty/fsm_vty.c @@ -35,7 +35,7 @@ /*! \addtogroup fsm * @{ - * \brief VTY interface for Osmocom FSM + * VTY interface for Osmocom FSM * * This is code implementing generic VTY access to Osmocom FSMs from * libosmocore. This means that any application can expose all state @@ -48,7 +48,7 @@ * consumption. */ extern struct llist_head osmo_g_fsms; -/*! \brief Print information about a FSM [class] to the given VTY +/*! Print information about a FSM [class] to the given VTY * \param vty The VTY to which to print * \param[in] fsm The FSM class to print */ @@ -74,7 +74,7 @@ void vty_out_fsm(struct vty *vty, struct osmo_fsm *fsm) } } -/*! \brief Print a FSM instance to the given VTY +/*! Print a FSM instance to the given VTY * \param vty The VTY to which to print * \param[in] fsmi The FSM instance to print */ @@ -174,7 +174,7 @@ DEFUN(show_fsm_inst, show_fsm_inst_cmd, return CMD_SUCCESS; } -/*! \brief Install VTY commands for FSM introspection +/*! Install VTY commands for FSM introspection * This installs a couple of VTY commands for introspection of FSM * classes as well as FSM instances. Call this once from your * application if you want to support those commands. */ |