diff options
| -rw-r--r-- | src/vty/fsm_vty.c | 9 | ||||
| -rw-r--r-- | src/vty/logging_vty.c | 25 | ||||
| -rw-r--r-- | src/vty/stats_vty.c | 13 | ||||
| -rw-r--r-- | src/vty/telnet_interface.c | 12 |
4 files changed, 29 insertions, 30 deletions
diff --git a/src/vty/fsm_vty.c b/src/vty/fsm_vty.c index 345be667..50c7fd52 100644 --- a/src/vty/fsm_vty.c +++ b/src/vty/fsm_vty.c @@ -1,5 +1,3 @@ -/*! \file fsm_vty.c - * Osmocom FSM introspection via VTY. */ /* * (C) 2016 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved @@ -35,9 +33,8 @@ #include <osmocom/core/logging.h> #include <osmocom/core/linuxlist.h> -/*! \addtogroup fsm - * @{ - * VTY interface for Osmocom FSM +/*! \file fsm_vty.c + * Osmocom FSM introspection via VTY. * * This is code implementing generic VTY access to Osmocom FSMs from * libosmocore. This means that any application can expose all state @@ -187,5 +184,3 @@ void osmo_fsm_vty_add_cmds(void) install_element_ve(&show_fsm_inst_cmd); install_element_ve(&show_fsm_insts_cmd); } - -/*! @} */ diff --git a/src/vty/logging_vty.c b/src/vty/logging_vty.c index 0ab76861..9b7d10af 100644 --- a/src/vty/logging_vty.c +++ b/src/vty/logging_vty.c @@ -1,5 +1,3 @@ -/*! \file logging_vty.c - * OpenBSC logging helper for the VTY. */ /* * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2014 by Holger Hans Peter Freyther @@ -41,14 +39,21 @@ #define LOG_STR "Configure logging sub-system\n" -/*! \addtogroup logging - * @{ +/*! \file logging_vty.c * Configuration of logging from VTY * - * This module implements functions that permit configuration of - * the libosmocore logging framework from VTY commands. This applies - * both to logging to the VTY (telnet sessions), as well as logging to - * other targets, such as sysslog, file, gsmtap, ... + * This module implements + * - functions that permit configuration of the libosmocore logging + * framework from VTY commands in the configure -> logging node. + * + * - functions that permit logging *to* a VTY session. Basically each + * VTY session gets its own log target, with configurable + * per-subsystem log levels. This is performed internally via the + * \ref log_target_create_vty function. + * + * You have to call \ref logging_vty_add_cmds from your application + * once to enable both of the above. + * */ extern const struct log_info *osmo_log_info; @@ -756,6 +761,8 @@ static int config_write_log(struct vty *vty) return 1; } +/*! Register logging related commands to the VTY. Call this once from + * your application if you want to support those commands. */ void logging_vty_add_cmds() { install_element_ve(&enable_logging_cmd); @@ -796,5 +803,3 @@ void logging_vty_add_cmds() #endif install_element(CONFIG_NODE, &cfg_log_gsmtap_cmd); } - -/* @} */ diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c index 95f04bc6..2ccbf668 100644 --- a/src/vty/stats_vty.c +++ b/src/vty/stats_vty.c @@ -1,5 +1,3 @@ -/*! \file stats_vty.c - * OpenBSC stats helper for the VTY. */ /* * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> * (C) 2009-2014 by Holger Hans Peter Freyther @@ -43,9 +41,14 @@ #define SHOW_STATS_STR "Show statistical values\n" -/*! \addtogroup stats - * @{ +/*! \file stats_vty.c * VTY interface for statsd / statistic items + * + * This code allows you to register a couple of VTY commands that + * permit configuration of the \ref stats functionality from the VTY. + * + * Use \ref osmo_stats_vty_add_cmds once at application start-up to + * enable related commands. */ /* containing version info */ @@ -609,5 +612,3 @@ void osmo_stats_vty_add_cmds() install_element_ve(&show_stats_asciidoc_table_cmd); } - -/*! @} */ diff --git a/src/vty/telnet_interface.c b/src/vty/telnet_interface.c index f82a7ff1..40154fef 100644 --- a/src/vty/telnet_interface.c +++ b/src/vty/telnet_interface.c @@ -1,5 +1,3 @@ -/*! \file telnet_interface.c - * minimalistic telnet/network interface it might turn into a wire interface */ /* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> * All Rights Reserved * @@ -37,8 +35,7 @@ #include <osmocom/vty/buffer.h> #include <osmocom/vty/command.h> -/*! \addtogroup telnet_interface - * @{ +/*! \file telnet_interface.c * Telnet interface towards Osmocom VTY * * This module contains the code implementing a telnet server for VTY @@ -46,7 +43,9 @@ * process in order to enable interactive command-line introspection, * interaction and configuration. * - * \file telnet_interface.c */ + * You typically call \ref telnet_init or \ref telnet_init_dynif once + * from your application code to enable this. + */ /* per connection data */ LLIST_HEAD(active_connections); @@ -219,6 +218,7 @@ void vty_event(enum event event, int sock, struct vty *vty) } } +/*! Close all telnet connections and release the telnet socket */ void telnet_exit(void) { struct telnet_connection *tc, *tc2; @@ -230,5 +230,3 @@ void telnet_exit(void) close(server_socket.fd); talloc_free(tall_telnet_ctx); } - -/*! @} */ |