summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJason Parker <jparker@digium.com>2007-11-12 23:44:20 +0000
committerJason Parker <jparker@digium.com>2007-11-12 23:44:20 +0000
commitcfbc4f5fb89344e2b0a07fbcb0c0fe35e09bca87 (patch)
treeb4f451a9593bedd2c9171dc8d03ca89228930385 /include
parentf033e50a1588a5829479ef83b7f2275b08669bf4 (diff)
Doxygen fixes.
Also fix a common typo I kept seeing (arguement) in various files. Closes issue #11222, patch by snuffy (with arguement > argument by me). git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@89202 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/cli.h14
-rw-r--r--include/asterisk/config.h2
-rw-r--r--include/asterisk/pbx.h2
-rw-r--r--include/asterisk/stringfields.h4
4 files changed, 14 insertions, 8 deletions
diff --git a/include/asterisk/cli.h b/include/asterisk/cli.h
index f478c4eb0..d0db49f48 100644
--- a/include/asterisk/cli.h
+++ b/include/asterisk/cli.h
@@ -220,6 +220,8 @@ char *ast_cli_complete(const char *word, char *const choices[], int pos);
/*!
* \brief Interprets a command
* Interpret a command s, sending output to fd
+ * \param fd pipe
+ * \param s incoming string
* \retval 0 on success
* \retval -1 on failure
*/
@@ -227,14 +229,16 @@ int ast_cli_command(int fd, const char *s);
/*!
* \brief Executes multiple CLI commands
- * Interpret strings separated by '\0' and execute each one, sending output to fd
+ * Interpret strings separated by NULL and execute each one, sending output to fd
+ * \param fd pipe
* \param size is the total size of the string
+ * \param s incoming string
* \retval number of commands executed
*/
int ast_cli_command_multiple(int fd, size_t size, const char *s);
/*! \brief Registers a command or an array of commands
- * \param e which cli entry to register
+ * \param e which cli entry to register.
* Register your own command
* \retval 0 on success
* \retval -1 on failure
@@ -252,7 +256,7 @@ int ast_cli_register_multiple(struct ast_cli_entry *e, int len);
* \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
- * \return 0.
+ * \return 0
*/
int ast_cli_unregister(struct ast_cli_entry *e);
@@ -280,14 +284,14 @@ int ast_cli_generatornummatches(const char *, const char *);
*
* The first entry (offset 0) of the result is the longest common substring
* in the results, useful to extend the string that has been completed.
- * Subsequent entries are all possible values, followe by a NULL.
+ * Subsequent entries are all possible values, followed by a NULL.
* All strings and the array itself are malloc'ed and must be freed
* by the caller.
*/
char **ast_cli_completion_matches(const char *, const char *);
/*!
- * \brief Command completion for the list of active channels
+ * \brief Command completion for the list of active channels.
*
* This can be called from a CLI command completion function that wants to
* complete from the list of active channels. 'rpos' is the required
diff --git a/include/asterisk/config.h b/include/asterisk/config.h
index 613867937..2064ba5e3 100644
--- a/include/asterisk/config.h
+++ b/include/asterisk/config.h
@@ -113,7 +113,7 @@ struct ast_variable *ast_category_root(struct ast_config *config, char *cat);
/*! \brief Goes through categories
* \param config Which config structure you wish to "browse"
* \param prev A pointer to a previous category.
- * This funtion is kind of non-intuitive in it's use. To begin, one passes NULL as the second arguement. It will return a pointer to the string of the first category in the file. From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards.
+ * This function is kind of non-intuitive in it's use. To begin, one passes NULL as the second argument. It will return a pointer to the string of the first category in the file. From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards.
*
* \retval a category on success
* \retval NULL on failure/no-more-categories
diff --git a/include/asterisk/pbx.h b/include/asterisk/pbx.h
index 645c8eedd..3479d6f2b 100644
--- a/include/asterisk/pbx.h
+++ b/include/asterisk/pbx.h
@@ -529,6 +529,8 @@ int ast_extension_cmp(const char *a, const char *b);
* \param exten new extension to add
* \param priority priority of new extension
* \param callerid callerid of extension
+ * \param found
+ * \param combined_find_spawn
*
* This adds a new extension to the asterisk extension list.
*
diff --git a/include/asterisk/stringfields.h b/include/asterisk/stringfields.h
index efa290593..5fe0fc30f 100644
--- a/include/asterisk/stringfields.h
+++ b/include/asterisk/stringfields.h
@@ -303,8 +303,8 @@ int __ast_string_field_init(struct ast_string_field_mgr *mgr,
\param x Pointer to a structure containing fields
\param field Name of the field to set
\param fmt printf-style format string
- \param args1 arguement one
- \param args2 arguement two
+ \param args1 argument one
+ \param args2 argument two
\return nothing
*/
#define ast_string_field_build_va(x, field, fmt, args1, args2) \