kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-14 13:58:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen documentation update from oej (issue #5505)

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2005-10-24 20:12:06 +00:00
parent c3226a226a
commit 3453e3efa5
244 changed files with 1101 additions and 748 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
include/asterisk/cli.h
View File

@@ -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);