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/telnet_interface.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/telnet_interface.c')
| -rw-r--r-- | src/vty/telnet_interface.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index d53881a1..d59516c1 100644 --- a/src/vty/telnet_interface.c +++ b/src/vty/telnet_interface.c @@ -38,7 +38,7 @@ /*! \addtogroup telnet_interface * @{ - * \brief Telnet interface towards Osmocom VTY + * Telnet interface towards Osmocom VTY * * This module contains the code implementing a telnet server for VTY * access. This telnet server gets linked into each libosmovty-using @@ -61,7 +61,7 @@ static struct osmo_fd server_socket = { .priv_nr = 0, }; -/*! \brief Initialize telnet based VTY interface listening to 127.0.0.1 +/*! Initialize telnet based VTY interface listening to 127.0.0.1 * \param[in] tall_ctx \ref talloc context * \param[in] priv private data to be passed to callback * \param[in] port UDP port number @@ -71,7 +71,7 @@ int telnet_init(void *tall_ctx, void *priv, int port) return telnet_init_dynif(tall_ctx, priv, "127.0.0.1", port); } -/*! \brief Initialize telnet based VTY interface +/*! Initialize telnet based VTY interface * \param[in] tall_ctx \ref talloc context * \param[in] priv private data to be passed to callback * \param[in] ip IP to listen to ('::1' for localhost, '::0' for all, ...) @@ -104,7 +104,7 @@ int telnet_init_dynif(void *tall_ctx, void *priv, const char *ip, int port) extern struct host host; -/*! \brief close a telnet connection */ +/*! close a telnet connection */ int telnet_close_client(struct osmo_fd *fd) { struct telnet_connection *conn = (struct telnet_connection*)fd->data; @@ -182,7 +182,7 @@ static int telnet_new_connection(struct osmo_fd *fd, unsigned int what) return 0; } -/*! \brief callback from core VTY code about VTY related events */ +/*! callback from core VTY code about VTY related events */ void vty_event(enum event event, int sock, struct vty *vty) { struct vty_signal_data sig_data = { 0, }; |