diff options
| -rw-r--r-- | apps/app_voicemail.c | 2 | ||||
| -rw-r--r-- | channels/chan_sip.c | 2 | ||||
| -rw-r--r-- | funcs/func_devstate.c | 2 | ||||
| -rw-r--r-- | include/asterisk/app.h | 11 | ||||
| -rw-r--r-- | include/asterisk/channel.h | 12 | ||||
| -rw-r--r-- | main/ast_expr2f.c | 161 |
6 files changed, 106 insertions, 84 deletions
diff --git a/apps/app_voicemail.c b/apps/app_voicemail.c index ab9e7906c..dceb2fbf4 100644 --- a/apps/app_voicemail.c +++ b/apps/app_voicemail.c @@ -35,7 +35,7 @@ c-client (http://www.washington.edu/imap/ * * * - * \note This file is now almost impossible to work with, due to all #ifdefs. + * \note This file is now almost impossible to work with, due to all \#ifdefs. * Feels like the database code before realtime. Someone - please come up * with a plan to clean this up. */ diff --git a/channels/chan_sip.c b/channels/chan_sip.c index f3dccf8d6..6c9ea335d 100644 --- a/channels/chan_sip.c +++ b/channels/chan_sip.c @@ -1244,7 +1244,7 @@ static void temp_pvt_cleanup(void *); /*! \brief A per-thread temporary pvt structure */ AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup); -/*! \breif Authentication list for realm authentication +/*! \brief Authentication list for realm authentication * \todo Move the sip_auth list to AST_LIST */ static struct sip_auth *authl = NULL; diff --git a/funcs/func_devstate.c b/funcs/func_devstate.c index 7125ca1b0..6c3d8e932 100644 --- a/funcs/func_devstate.c +++ b/funcs/func_devstate.c @@ -24,7 +24,7 @@ * * \ingroup functions * - * \note Props go out to Ahrimanes in #asterisk for requesting this at 4:30 AM + * \note Props go out to Ahrimanes in \#asterisk for requesting this at 4:30 AM * when I couldn't sleep. :) */ diff --git a/include/asterisk/app.h b/include/asterisk/app.h index fc763d5f0..76683d5eb 100644 --- a/include/asterisk/app.h +++ b/include/asterisk/app.h @@ -165,10 +165,13 @@ int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, in /*! * \brief Stream a file with fast forward, pause, reverse, restart. - * \param offsetms Before calling this function, set this to be the number - * of ms to start from the beginning of the file. When the function - * returns, it will be the number of ms from the beginning where the - * playback stopped. Pass NULL if you don't care. + * \param chan + * \param file filename + * \param fwd, rev, stop, pause, restart, skipms, offsetms + * Before calling this function, set this to be the number + * of ms to start from the beginning of the file. When the function + * returns, it will be the number of ms from the beginning where the + * playback stopped. Pass NULL if you don't care. */ int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms); diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index 1cbf67410..8c0b6a51a 100644 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -107,12 +107,12 @@ so a transcoding module is needed. References: - - ast_channel_early_bridge() - - ast_channel_bridge() - - app_meetme.c - - \ref AstRTPbridge - - ast_rtp_bridge() - - \ref Def_Channel + \li \see ast_channel_early_bridge() + \li \see ast_channel_bridge() + \li \see app_meetme.c + \li \ref AstRTPbridge + \li \see ast_rtp_bridge() + \li \ref Def_Channel */ /*! \page AstFileDesc File descriptors diff --git a/main/ast_expr2f.c b/main/ast_expr2f.c index 7888a594a..860f19f2d 100644 --- a/main/ast_expr2f.c +++ b/main/ast_expr2f.c @@ -1698,7 +1698,8 @@ extern int ast_yylex \ #define YY_RULE_SETUP \ YY_USER_ACTION -/** The main scanner function which does all the work. +/*! + * \brief The main scanner function which does all the work. */ YY_DECL { @@ -2465,10 +2466,11 @@ static int yy_get_next_buffer (yyscan_t yyscanner) } #endif /* ifndef YY_NO_INPUT */ -/** Immediately switch to a different input stream. - * @param input_file A readable stream. - * @param yyscanner The scanner object. - * @note This function does not reset the start condition to @c INITIAL . +/*! + * \brief Immediately switch to a different input stream. + * \param input_file A readable stream. + * \param yyscanner The scanner object. + * \note This function does not reset the start condition to \c INITIAL . */ void ast_yyrestart (FILE * input_file , yyscan_t yyscanner) { @@ -2484,9 +2486,10 @@ static int yy_get_next_buffer (yyscan_t yyscanner) ast_yy_load_buffer_state(yyscanner ); } -/** Switch to a different input buffer. - * @param new_buffer The new input buffer. - * @param yyscanner The scanner object. +/*! + * \brief Switch to a different input buffer. + * \param new_buffer The new input buffer. + * \param yyscanner The scanner object. */ void ast_yy_switch_to_buffer (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) { @@ -2529,11 +2532,12 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner) yyg->yy_hold_char = *yyg->yy_c_buf_p; } -/** Allocate and initialize an input buffer state. - * @param file A readable stream. - * @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE. - * @param yyscanner The scanner object. - * @return the allocated buffer state. +/*! + * \brief Allocate and initialize an input buffer state. + * \param file A readable stream. + * \param size The character buffer size in bytes. When in doubt, use \c YY_BUF_SIZE. + * \param yyscanner The scanner object. + * \return the allocated buffer state. */ YY_BUFFER_STATE ast_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner) { @@ -2559,9 +2563,10 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner) return b; } -/** Destroy the buffer. - * @param b a buffer created with ast_yy_create_buffer() - * @param yyscanner The scanner object. +/*! + * \brief Destroy the buffer. + * \param b a buffer created with ast_yy_create_buffer() + * \param yyscanner The scanner object. */ void ast_yy_delete_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner) { @@ -2612,9 +2617,10 @@ extern int isatty (int ); errno = oerrno; } -/** Discard all buffered characters. On the next scan, YY_INPUT will be called. - * @param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER. - * @param yyscanner The scanner object. +/*! + * \brief Discard all buffered characters. On the next scan, YY_INPUT will be called. + * \param b the buffer state to be flushed, usually \c YY_CURRENT_BUFFER. + * \param yyscanner The scanner object. */ void ast_yy_flush_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner) { @@ -2640,11 +2646,11 @@ extern int isatty (int ); ast_yy_load_buffer_state(yyscanner ); } -/** Pushes the new state onto the stack. The new state becomes - * the current state. This function will allocate the stack - * if necessary. - * @param new_buffer The new state. - * @param yyscanner The scanner object. +/*! + * \brief Pushes the new state onto the stack. The new state becomes + * the current state. This function will allocate the stack if necessary. + * \param new_buffer The new state. + * \param yyscanner The scanner object. */ void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) { @@ -2673,9 +2679,10 @@ void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) yyg->yy_did_buffer_switch_on_eof = 1; } -/** Removes and deletes the top of the stack, if present. +/*! + * \brief Removes and deletes the top of the stack, if present. * The next element becomes the new top. - * @param yyscanner The scanner object. + * \param yyscanner The scanner object. */ void ast_yypop_buffer_state (yyscan_t yyscanner) { @@ -2694,8 +2701,8 @@ void ast_yypop_buffer_state (yyscan_t yyscanner) } } -/* Allocates the stack if it does not exist. - * Guarantees space for at least one push. +/*! + * \brief Allocates the stack if it does not exist Guarantees space for at least one push. */ static void ast_yyensure_buffer_stack (yyscan_t yyscanner) { @@ -2737,11 +2744,12 @@ static void ast_yyensure_buffer_stack (yyscan_t yyscanner) } } -/** Setup the input buffer state to scan directly from a user-specified character buffer. - * @param base the character buffer - * @param size the size in bytes of the character buffer - * @param yyscanner The scanner object. - * @return the newly allocated buffer state object. +/*! + * \brief Setup the input buffer state to scan directly from a user-specified character buffer. + * \param base the character buffer + * \param size the size in bytes of the character buffer + * \param yyscanner The scanner object. + * \return the newly allocated buffer state object. */ YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yyscanner) { @@ -2772,12 +2780,13 @@ YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yys return b; } -/** 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 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 +/*! + * \brief 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 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 * ast_yy_scan_bytes() instead. */ YY_BUFFER_STATE ast_yy_scan_string (yyconst char * yy_str , yyscan_t yyscanner) @@ -2786,12 +2795,13 @@ YY_BUFFER_STATE ast_yy_scan_string (yyconst char * yy_str , yyscan_t yyscanner) return ast_yy_scan_bytes(yy_str,strlen(yy_str) ,yyscanner); } -/** Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will +/*! + * \brief Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will * scan from a @e copy of @a bytes. - * @param bytes the byte buffer to scan - * @param len the number of bytes in the buffer pointed to by @a bytes. - * @param yyscanner The scanner object. - * @return the newly allocated buffer state object. + * \param bytes the byte buffer to scan + * \param len the number of bytes in the buffer pointed to by @a bytes. + * \param yyscanner The scanner object. + * \return the newly allocated buffer state object. */ YY_BUFFER_STATE ast_yy_scan_bytes (yyconst char * bytes, int len , yyscan_t yyscanner) { @@ -2852,8 +2862,9 @@ static void yy_fatal_error (yyconst char* msg , yyscan_t yyscanner) /* Accessor methods (get/set functions) to struct members. */ -/** Get the user-defined data for this scanner. - * @param yyscanner The scanner object. +/*! + * \brief Get the user-defined data for this scanner. + * \param yyscanner The scanner object. */ YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner) { @@ -2861,8 +2872,9 @@ YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner) return yyextra; } -/** Get the current line number. - * @param yyscanner The scanner object. +/*! + * \brief Get the current line number. + * \param yyscanner The scanner object. */ int ast_yyget_lineno (yyscan_t yyscanner) { @@ -2874,8 +2886,9 @@ int ast_yyget_lineno (yyscan_t yyscanner) return yylineno; } -/** Get the current column number. - * @param yyscanner The scanner object. +/*! + * \brief Get the current column number. + * \param yyscanner The scanner object. */ int ast_yyget_column (yyscan_t yyscanner) { @@ -2887,8 +2900,9 @@ int ast_yyget_column (yyscan_t yyscanner) return yycolumn; } -/** Get the input stream. - * @param yyscanner The scanner object. +/*! + * \brief Get the input stream. + * \param yyscanner The scanner object. */ FILE *ast_yyget_in (yyscan_t yyscanner) { @@ -2896,8 +2910,9 @@ FILE *ast_yyget_in (yyscan_t yyscanner) return yyin; } -/** Get the output stream. - * @param yyscanner The scanner object. +/*! + * \brief Get the output stream. + * \param yyscanner The scanner object. */ FILE *ast_yyget_out (yyscan_t yyscanner) { @@ -2905,8 +2920,9 @@ FILE *ast_yyget_out (yyscan_t yyscanner) return yyout; } -/** Get the length of the current token. - * @param yyscanner The scanner object. +/*! + * \brief Get the length of the current token. + * \param yyscanner The scanner object. */ int ast_yyget_leng (yyscan_t yyscanner) { @@ -2915,7 +2931,7 @@ int ast_yyget_leng (yyscan_t yyscanner) } /** Get the current token. - * @param yyscanner The scanner object. + * \param yyscanner The scanner object. */ char *ast_yyget_text (yyscan_t yyscanner) @@ -2924,9 +2940,10 @@ char *ast_yyget_text (yyscan_t yyscanner) return yytext; } -/** Set the user-defined data. This data is never touched by the scanner. - * @param user_defined The data to be associated with this scanner. - * @param yyscanner The scanner object. +/*! + * \brief Set the user-defined data. This data is never touched by the scanner. + * \param user_defined The data to be associated with this scanner. + * \param yyscanner The scanner object. */ void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner) { @@ -2934,9 +2951,10 @@ void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner) yyextra = user_defined ; } -/** Set the current line number. - * @param line_number - * @param yyscanner The scanner object. +/*! + * \brief Set the current line number. + * \param line_number + * \param yyscanner The scanner object. */ void ast_yyset_lineno (int line_number , yyscan_t yyscanner) { @@ -2949,9 +2967,10 @@ void ast_yyset_lineno (int line_number , yyscan_t yyscanner) yylineno = line_number; } -/** Set the current column. - * @param line_number - * @param yyscanner The scanner object. +/*! + * \brief Set the current column. + * \param column_no + * \param yyscanner The scanner object. */ void ast_yyset_column (int column_no , yyscan_t yyscanner) { @@ -2964,11 +2983,11 @@ void ast_yyset_column (int column_no , yyscan_t yyscanner) yycolumn = column_no; } -/** Set the input stream. This does not discard the current - * input buffer. - * @param in_str A readable stream. - * @param yyscanner The scanner object. - * @see ast_yy_switch_to_buffer +/*! + * \brief Set the input stream. This does not discard the current input buffer. + * \param in_str A readable stream. + * \param yyscanner The scanner object. + * \see ast_yy_switch_to_buffer */ void ast_yyset_in (FILE * in_str , yyscan_t yyscanner) { |