diff options
Diffstat (limited to 'src/vty')
| -rw-r--r-- | src/vty/command.c | 26 | ||||
| -rw-r--r-- | src/vty/fsm_vty.c | 8 | ||||
| -rw-r--r-- | src/vty/logging_vty.c | 2 | ||||
| -rw-r--r-- | src/vty/stats_vty.c | 4 | ||||
| -rw-r--r-- | src/vty/telnet_interface.c | 10 | ||||
| -rw-r--r-- | src/vty/utils.c | 6 | ||||
| -rw-r--r-- | src/vty/vector.c | 2 | ||||
| -rw-r--r-- | src/vty/vty.c | 28 |
8 files changed, 43 insertions, 43 deletions
diff --git a/src/vty/command.c b/src/vty/command.c index 01684622..a0824d39 100644 --- a/src/vty/command.c +++ b/src/vty/command.c @@ -43,7 +43,7 @@ Boston, MA 02110-1301, USA. */ /*! \addtogroup command * @{ - * \brief VTY command handling + * VTY command handling */ /*! \file command.c */ @@ -88,7 +88,7 @@ struct cmd_node config_node = { /* Default motd string. */ const char *default_motd = ""; -/*! \brief print the version (and optionally copyright) information +/*! print the version (and optionally copyright) information * * This is called from main when a daemon is invoked with -v or --version. */ void print_version(int print_copyright) @@ -123,7 +123,7 @@ char *argv_concat(const char **argv, int argc, int shift) return str; } -/*! \brief Install top node of command vector. */ +/*! Install top node of command vector. */ void install_node(struct cmd_node *node, int (*func) (struct vty *)) { vector_set_index(cmdvec, node->node, node); @@ -160,7 +160,7 @@ static int is_config_child(struct vty *vty) return vty->node > CONFIG_NODE; } -/*! \brief Sort each node's command element according to command string. */ +/*! Sort each node's command element according to command string. */ void sort_node(void) { unsigned int i, j; @@ -240,7 +240,7 @@ vector cmd_make_strvec(const char *string) } } -/*! \brief Free allocated string vector. */ +/*! Free allocated string vector. */ void cmd_free_strvec(vector v) { unsigned int i; @@ -256,7 +256,7 @@ void cmd_free_strvec(vector v) vector_free(v); } -/*! \brief Fetch next description. Used in \ref cmd_make_descvec(). */ +/*! Fetch next description. Used in \ref cmd_make_descvec(). */ static char *cmd_desc_str(const char **string) { const char *cp, *start; @@ -291,7 +291,7 @@ static char *cmd_desc_str(const char **string) return token; } -/*! \brief New string vector. */ +/*! New string vector. */ static vector cmd_make_descvec(const char *string, const char *descstr) { int multiple = 0; @@ -394,7 +394,7 @@ static int cmd_cmdsize(vector strvec) return size; } -/*! \brief Return prompt character of specified node. */ +/*! Return prompt character of specified node. */ const char *cmd_prompt(enum node_type node) { struct cmd_node *cnode; @@ -404,7 +404,7 @@ const char *cmd_prompt(enum node_type node) } /*! - * \brief escape all special asciidoc symbols + * escape all special asciidoc symbols * \param unsafe string * \return a new talloc char * */ @@ -595,7 +595,7 @@ static int vty_dump_nodes(struct vty *vty) return 0; } -/* \brief Check if a command with given string exists at given node */ +/* Check if a command with given string exists at given node */ static int check_element_exists(struct cmd_node *cnode, const char *cmdstring) { int i; @@ -611,7 +611,7 @@ static int check_element_exists(struct cmd_node *cnode, const char *cmdstring) return 0; } -/*! \brief Install a command into a node +/*! Install a command into a node * \param[in] ntype Node Type * \param[cmd] element to be installed */ @@ -3406,7 +3406,7 @@ void vty_install_default(int node) } /** - * \brief Write the current running config to a given file + * Write the current running config to a given file * \param[in] vty the vty of the code * \param[in] filename where to store the file * \return 0 in case of success. @@ -3426,7 +3426,7 @@ int osmo_vty_write_config_file(const char *filename) } /** - * \brief Save the current state to the config file + * Save the current state to the config file * \return 0 in case of success. * * If the filename already exists create a filename.sav 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. */ diff --git a/src/vty/logging_vty.c b/src/vty/logging_vty.c index 8c8a3235..4cb13792 100644 --- a/src/vty/logging_vty.c +++ b/src/vty/logging_vty.c @@ -41,7 +41,7 @@ /*! \addtogroup logging * @{ - * \brief Configuration of logging from VTY + * Configuration of logging from VTY * * This module implements functions that permit configuration of * the libosmocore logging framework from VTY commands. This applies diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c index af69289f..05578208 100644 --- a/src/vty/stats_vty.c +++ b/src/vty/stats_vty.c @@ -43,7 +43,7 @@ /*! \addtogroup stats * @{ - * \brief VTY interface for statsd / statistic items + * VTY interface for statsd / statistic items */ /* containing version info */ @@ -576,7 +576,7 @@ static int config_write_stats(struct vty *vty) return 1; } -/*! \brief Add stats related commands to the VTY +/*! Add stats related commands to the VTY * Call this once during your application initialization if you would * like to have stats VTY commands enabled. */ 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, }; diff --git a/src/vty/utils.c b/src/vty/utils.c index 6772593d..267d76e8 100644 --- a/src/vty/utils.c +++ b/src/vty/utils.c @@ -67,7 +67,7 @@ static int rate_ctr_handler( return 0; } -/*! \brief print a rate counter group to given VTY +/*! print a rate counter group to given VTY * \param[in] vty The VTY to which it should be printed * \param[in] prefix Any additional log prefix ahead of each line * \param[in] ctrg Rate counter group to be printed @@ -126,7 +126,7 @@ static int osmo_stat_item_handler( return 0; } -/*! \brief print a stat item group to given VTY +/*! print a stat item group to given VTY * \param[in] vty The VTY to which it should be printed * \param[in] prefix Any additional log prefix ahead of each line * \param[in] statg Stat item group to be printed @@ -200,7 +200,7 @@ void vty_out_statistics_full(struct vty *vty, const char *prefix) vty_out_statistics_partial(vty, prefix, INT_MAX); } -/*! \brief Generate a VTY command string from value_string */ +/*! Generate a VTY command string from value_string */ char *vty_cmd_string_from_valstr(void *ctx, const struct value_string *vals, const char *prefix, const char *sep, const char *end, int do_lower) diff --git a/src/vty/vector.c b/src/vty/vector.c index b95e15c3..c21bca70 100644 --- a/src/vty/vector.c +++ b/src/vty/vector.c @@ -29,7 +29,7 @@ /*! \addtogroup vector * @{ - * \brief Generic vector routines, used by VTY internally + * Generic vector routines, used by VTY internally */ void *tall_vty_vec_ctx; diff --git a/src/vty/vty.c b/src/vty/vty.c index 2ec9538c..6e60eb75 100644 --- a/src/vty/vty.c +++ b/src/vty/vty.c @@ -103,7 +103,7 @@ static void vty_clear_buf(struct vty *vty) memset(vty->buf, 0, vty->max); } -/*! \brief Allocate a new vty interface structure */ +/*! Allocate a new vty interface structure */ struct vty *vty_new(void) { struct vty *new = talloc_zero(tall_vty_ctx, struct vty); @@ -196,7 +196,7 @@ static void vty_auth(struct vty *vty, char *buf) } } -/*! \brief Close a given vty interface. */ +/*! Close a given vty interface. */ void vty_close(struct vty *vty) { int i; @@ -237,14 +237,14 @@ void vty_close(struct vty *vty) talloc_free(vty); } -/*! \brief Return if this VTY is a shell or not */ +/*! Return if this VTY is a shell or not */ int vty_shell(struct vty *vty) { return vty->type == VTY_SHELL ? 1 : 0; } -/*! \brief VTY standard output function +/*! VTY standard output function * \param[in] vty VTY to which we should print * \param[in] format variable-length format string */ @@ -304,7 +304,7 @@ int vty_out(struct vty *vty, const char *format, ...) return len; } -/*! \brief print a newline on the given VTY */ +/*! print a newline on the given VTY */ int vty_out_newline(struct vty *vty) { const char *p = vty_newline(vty); @@ -312,19 +312,19 @@ int vty_out_newline(struct vty *vty) return 0; } -/*! \brief return the current index of a given VTY */ +/*! return the current index of a given VTY */ void *vty_current_index(struct vty *vty) { return vty->index; } -/*! \brief return the current node of a given VTY */ +/*! return the current node of a given VTY */ int vty_current_node(struct vty *vty) { return vty->node; } -/*! \brief Lock the configuration to a given VTY +/*! Lock the configuration to a given VTY * \param[in] vty VTY to which the config shall be locked * \returns 1 on success, 0 on error * @@ -339,7 +339,7 @@ int vty_config_lock(struct vty *vty) return vty->config; } -/*! \brief Unlock the configuration from a given VTY +/*! Unlock the configuration from a given VTY * \param[in] vty VTY from which the configuration shall be unlocked * \returns 0 in case of success */ @@ -1272,7 +1272,7 @@ static void vty_buffer_reset(struct vty *vty) vty_redraw_line(vty); } -/*! \brief Read data via vty socket. */ +/*! Read data via vty socket. */ int vty_read(struct vty *vty) { int i; @@ -1492,7 +1492,7 @@ vty_read_file(FILE *confp, void *priv) return 0; } -/*! \brief Create new vty structure. */ +/*! Create new vty structure. */ struct vty * vty_create (int vty_sock, void *priv) { @@ -1702,7 +1702,7 @@ struct cmd_node vty_node = { 1, }; -/*! \brief Reset all VTY status. */ +/*! Reset all VTY status. */ void vty_reset(void) { unsigned int i; @@ -1760,7 +1760,7 @@ void vty_init_vtysh(void) extern void *tall_bsc_ctx; -/*! \brief Initialize VTY layer +/*! Initialize VTY layer * \param[in] app_info application information */ /* Install vty's own commands like `who' command. */ @@ -1797,7 +1797,7 @@ void vty_init(struct vty_app_info *app_info) install_element(VTY_NODE, &vty_bind_cmd); } -/*! \brief Read the configuration file using the VTY code +/*! Read the configuration file using the VTY code * \param[in] file_name file name of the configuration file * \param[in] priv private data to be passed to \ref vty_read_file */ |