diff options
author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-10-24 20:12:06 +0000 |
---|---|---|
committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-10-24 20:12:06 +0000 |
commit | 2c3b3edc86c6999c3053c131972a3e29e7621bac (patch) | |
tree | b3ba750361c8145e6c629b37179fb9f1750094b4 /include/asterisk/cli.h | |
parent | 009102fa0d7a8f95ef396d510a9a731f6f9f6f1e (diff) |
Doxygen documentation update from oej (issue #5505)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6847 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/cli.h')
-rwxr-xr-x | include/asterisk/cli.h | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/include/asterisk/cli.h b/include/asterisk/cli.h index 20a259be1..4dcdeab65 100755 --- a/include/asterisk/cli.h +++ b/include/asterisk/cli.h @@ -16,8 +16,8 @@ * at the top of the source tree. */ -/* - * Standard Command Line Interface +/*! \file + * \brief Standard Command Line Interface */ #ifndef _ASTERISK_CLI_H @@ -42,7 +42,7 @@ extern void ast_cli(int fd, char *fmt, ...) #define AST_CLI_COMPLETE_EOF "_EOF_" -/*! A command line entry */ +/*! \brief A command line entry */ struct ast_cli_entry { /*! Null terminated list of the words of the command */ char *cmda[AST_MAX_CMD_LEN]; @@ -60,14 +60,13 @@ struct ast_cli_entry { int inuse; }; -/*! Interprets a command */ -/*! Interpret a command s, sending output to fd +/*! \brief Interprets a command + * Interpret a command s, sending output to fd * Returns 0 on succes, -1 on failure */ extern int ast_cli_command(int fd, char *s); -/*! Registers a command or an array of commands */ -/*! +/*! \brief Registers a command or an array of commands * \param e which cli entry to register * Register your own command * Returns 0 on success, -1 on failure @@ -75,14 +74,14 @@ extern int ast_cli_command(int fd, char *s); extern int ast_cli_register(struct ast_cli_entry *e); /*! + * \brief Register multiple commands * \param e pointer to first cli entry to register * \param len number of entries to register - * Register multiple commands */ extern void ast_cli_register_multiple(struct ast_cli_entry *e, int len); -/*! Unregisters a command or an array of commands */ -/*! +/*! \brief Unregisters a command or an array of commands + * * \param e which cli entry to unregister * Unregister your own command. You must pass a completed ast_cli_entry structure * Returns 0. @@ -90,14 +89,14 @@ extern void ast_cli_register_multiple(struct ast_cli_entry *e, int len); extern int ast_cli_unregister(struct ast_cli_entry *e); /*! + * \brief Unregister multiple commands * \param e pointer to first cli entry to unregister * \param len number of entries to unregister - * Unregister multiple commands */ extern void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len); -/*! Readline madness */ -/* Useful for readline, that's about it +/*! \brief Readline madness + * Useful for readline, that's about it * Returns 0 on success, -1 on failure */ extern char *ast_cli_generator(char *, char *, int); |