Doxygen fixes.
authorJason Parker <jparker@digium.com>
Mon, 12 Nov 2007 23:44:20 +0000 (23:44 +0000)
committerJason Parker <jparker@digium.com>
Mon, 12 Nov 2007 23:44:20 +0000 (23:44 +0000)
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

13 files changed:
channels/chan_unistim.c
include/asterisk/cli.h
include/asterisk/config.h
include/asterisk/pbx.h
include/asterisk/stringfields.h
main/ast_expr2f.c
pbx/pbx_lua.c
res/res_clioriginate.c
res/res_config_sqlite.c
res/res_convert.c
res/res_crypto.c
res/res_features.c
res/res_monitor.c

index 37a2f59..f96eb36 100644 (file)
@@ -386,7 +386,7 @@ struct unistim_line {
        ast_mutex_t lock;
        /*! Like 200 */
        char name[80];
-       /*! Like USTM/200@black */
+       /*! Like USTM/200\@black */
        char fullname[80];
        /*! pointer to our current connection, channel... */
        struct unistim_subchannel *subs[MAX_SUBS];
index f478c4e..d0db49f 100644 (file)
@@ -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
index 6138679..2064ba5 100644 (file)
@@ -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
index 645c8ee..3479d6f 100644 (file)
@@ -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.
  *
index efa2905..5fe0fc3 100644 (file)
@@ -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) \
index c9ae8de..a39af46 100644 (file)
@@ -2774,7 +2774,7 @@ YY_BUFFER_STATE ast_yy_scan_buffer  (char * base, yy_size_t  size , yyscan_t yys
 
 /** Setup the input buffer state to scan a string. The next call to ast_yylex() will
  * scan from a @e copy of @a str.
- * @param str a NUL-terminated string to scan
+ * @param yy_str a NUL-terminated string to scan
  * @param yyscanner The scanner object.
  * @return the newly allocated buffer state object.
  * @note If you want to scan bytes that may contain NUL values, then use
@@ -2950,7 +2950,7 @@ void ast_yyset_lineno (int  line_number , yyscan_t yyscanner)
 }
 
 /** Set the current column.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void ast_yyset_column (int  column_no , yyscan_t yyscanner)
index 0465ff9..c4701b3 100644 (file)
@@ -868,9 +868,9 @@ static char *lua_read_extensions_file(lua_State *L, long *size)
  * \brief Load the extensions.lua file from the internal buffer
  *
  * \param L the lua_State to use
+ * \param chan channel to work on
  *
  * This function also sets up some constructs used by the extensions.lua file.
- *
  * In the event of an error, an error string will be pushed onto the lua stack.
  *
  * \retval 0 success
index a0e5984..09cde4d 100644 (file)
@@ -117,9 +117,9 @@ static char *orig_exten(int fd, const char *chan, const char *data)
  * \brief handle for orgination app or exten.
  * \param e pointer to the CLI structure to initialize
  * \param cmd operation to execute
- * \param a structure that contains either application or extension arguements
+ * \param a structure that contains either application or extension arguments
  * \retval CLI_SUCCESS on success.
- * \retval CLI_SHOWUSAGE  on failure.
+ * \retval CLI_SHOWUSAGE on failure.
 */
 static char *handle_orig(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 {
index ae44caf..d05a382 100644 (file)
@@ -448,9 +448,9 @@ static int realtime_destroy_handler(const char *database, const char *table,
 /*!
  * \brief Asterisk callback function for the CLI status command.
  *
- * \param fd file descriptor provided by Asterisk to use with ast_cli()
- * \param argc number of arguments
- * \param argv arguments list
+ * \param e CLI command
+ * \param cmd 
+ * \param a CLI argument list
  * \return RESULT_SUCCESS
  */
 static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
index 974cf6a..c91c5e7 100644 (file)
@@ -58,9 +58,9 @@ static int split_ext(char *filename, char **name, char **ext)
 
 /*! 
  * \brief Convert a file from one format to another 
- * \param fd file descriptor
- * \param argc no arguements
- * \param argv list of arguements
+ * \param e CLI entry
+ * \param cmd command number
+ * \param a list of cli arguments
  * \retval CLI_SUCCESS on success.
  * \retval CLI_SHOWUSAGE or CLI_FAILURE on failure.
 */
index b32837b..e76cab2 100644 (file)
@@ -494,9 +494,9 @@ static void md52sum(char *sum, unsigned char *md5)
 
 /*! 
  * \brief show the list of RSA keys 
- * \param fd file descriptor
- * \param argc no of arguements
- * \param argv list of arguements
+ * \param e CLI command
+ * \param cmd
+ * \param a list of CLI arguments
  * \return RESULT_SUCCESS
 */
 static char *handle_cli_keys_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
@@ -540,9 +540,9 @@ static char *handle_cli_keys_show(struct ast_cli_entry *e, int cmd, struct ast_c
 
 /*! 
  * \brief initialize all RSA keys  
- * \param fd file descriptor
- * \param argc no of arguements
- * \param argv list of arguements
+ * \param e CLI command
+ * \param cmd 
+ * \param a list of CLI arguments
  * \return RESULT_SUCCESS
 */
 static char *handle_cli_keys_init(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
index e4fec53..56053f9 100644 (file)
@@ -2583,7 +2583,7 @@ static int action_bridge(struct mansession *s, const struct message *m)
  *  
  * Check right usage, lock parking lot, display parked calls, unlock parking lot list.
  * \retval CLI_SUCCESS on success.
- * \retval CLI_SHOWUSAGE on incorrect number of arguements.
+ * \retval CLI_SHOWUSAGE on incorrect number of arguments.
  * \retval NULL when tab completion is used.
 */
 static char *handle_parkedcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
index ec770ea..3a5aa59 100644 (file)
@@ -80,7 +80,7 @@ static char *monitor_descrip = "  Monitor([file_format[:urlbase],[fname_base],[o
 "          and a target mixed file name which is the same as the leg file names\n"
 "          only without the in/out designator.\n"
 "          If MONITOR_EXEC_ARGS is set, the contents will be passed on as\n"
-"          additional arguements to MONITOR_EXEC\n"
+"          additional arguments to MONITOR_EXEC\n"
 "          Both MONITOR_EXEC and the Mix flag can be set from the\n"
 "          administrator interface\n"
 "\n"
@@ -419,7 +419,7 @@ int ast_monitor_change_fname(struct ast_channel *chan, const char *fname_base, i
 /*!
  * \brief Start monitor
  * \param chan
- * \param data arguements passed  fname|options
+ * \param data arguments passed fname|options
  * \retval 0 on success.
  * \retval -1 on failure.
 */