kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-30 10:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change javadoc style code documentation to the same format we use elsewhere.

Browse Source 
(issue #9864, patch from snuffy)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@67024 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2007-06-04 15:56:13 +00:00
parent 4538cec96a
commit e1375b96c2
3 changed files with 232 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
main/app.c
View File

@@ -55,12 +55,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
static AST_LIST_HEAD_STATIC(groups, ast_group_info); static AST_LIST_HEAD_STATIC(groups, ast_group_info);
/* ! /*!
This function presents a dialtone and reads an extension into 'collect' * \brief This function presents a dialtone and reads an extension into 'collect'
which must be a pointer to a **pre-initialized** array of char having a * which must be a pointer to a **pre-initialized** array of char having a
size of 'size' suitable for writing to. It will collect no more than the smaller * size of 'size' suitable for writing to. It will collect no more than the smaller
of 'maxlen' or 'size' minus the original strlen() of collect digits. * of 'maxlen' or 'size' minus the original strlen() of collect digits.
\return 0 if extension does not exist, 1 if extension exists * \param chan struct.
* \param context
* \param collect
* \param size
* \param maxlen
* \param timeout timeout in seconds
*
* \return 0 if extension does not exist, 1 if extension exists
*/ */
int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout) int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout)
{ {
@@ -98,11 +105,13 @@ int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect,
return res; return res;
} }
/*! \param c The channel to read from /*!
* \param prompt The file to stream to the channel * \brief ast_app_getdata
* \param s The string to read in to. Must be at least the size of your length * \param c The channel to read from
* \param maxlen How many digits to read (maximum) * \param prompt The file to stream to the channel
* \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for * \param s The string to read in to. Must be at least the size of your length
* \param maxlen How many digits to read (maximum)
* \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for
* "ludicrous time" (essentially never times out) */ * "ludicrous time" (essentially never times out) */
int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout) int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout)
{ {
@@ -491,19 +500,19 @@ static int global_silence_threshold = 128;
static int global_maxsilence = 0; static int global_maxsilence = 0;
/*! Optionally play a sound file or a beep, then record audio and video from the channel. /*! Optionally play a sound file or a beep, then record audio and video from the channel.
* @param chan Channel to playback to/record from. * \param chan Channel to playback to/record from.
* @param playfile Filename of sound to play before recording begins. * \param playfile Filename of sound to play before recording begins.
* @param recordfile Filename to record to. * \param recordfile Filename to record to.
* @param maxtime Maximum length of recording (in milliseconds). * \param maxtime Maximum length of recording (in milliseconds).
* @param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'. * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
* @param duration Where to store actual length of the recorded message (in milliseconds). * \param duration Where to store actual length of the recorded message (in milliseconds).
* @param beep Whether to play a beep before starting to record. * \param beep Whether to play a beep before starting to record.
* @param silencethreshold * \param silencethreshold
* @param maxsilence Length of silence that will end a recording (in milliseconds). * \param maxsilence Length of silence that will end a recording (in milliseconds).
* @param path Optional filesystem path to unlock. * \param path Optional filesystem path to unlock.
* @param prepend If true, prepend the recorded audio to an existing file. * \param prepend If true, prepend the recorded audio to an existing file.
* @param acceptdtmf DTMF digits that will end the recording. * \param acceptdtmf DTMF digits that will end the recording.
* @param canceldtmf DTMF digits that will cancel the recording. * \param canceldtmf DTMF digits that will cancel the recording.
*/ */
static int __ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int beep, int silencethreshold, int maxsilence, const char *path, int prepend, const char *acceptdtmf, const char *canceldtmf) static int __ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int beep, int silencethreshold, int maxsilence, const char *path, int prepend, const char *acceptdtmf, const char *canceldtmf)

173
main/ast_expr2f.c
View File

@@ -229,8 +229,8 @@ struct yy_buffer_state
*/ */
int yy_at_bol; int yy_at_bol;
int yy_bs_lineno; /**< The line count. */ int yy_bs_lineno; /*!< The line count. */
int yy_bs_column; /**< The column count. */ int yy_bs_column; /*!< The column count. */
/* Whether to try to fill the input buffer when we reach the /* Whether to try to fill the input buffer when we reach the
* end of it. * end of it.
@@ -1436,9 +1436,9 @@ struct yyguts_t
/* The rest are the same as the globals declared in the non-reentrant scanner. */ /* The rest are the same as the globals declared in the non-reentrant scanner. */
FILE *yyin_r, *yyout_r; FILE *yyin_r, *yyout_r;
size_t yy_buffer_stack_top; /**< index of top of stack. */ size_t yy_buffer_stack_top; /*!< index of top of stack. */
size_t yy_buffer_stack_max; /**< capacity of stack. */ size_t yy_buffer_stack_max; /*!< capacity of stack. */
YY_BUFFER_STATE * yy_buffer_stack; /**< Stack as an array. */ YY_BUFFER_STATE * yy_buffer_stack; /*!< Stack as an array. */
char yy_hold_char; char yy_hold_char;
int yy_n_chars; int yy_n_chars;
int yyleng_r; int yyleng_r;
@@ -1619,7 +1619,8 @@ extern int ast_yylex (YYSTYPE * yylval_param,YYLTYPE * yylloc_param ,yyscan_t yy
#define YY_RULE_SETUP \ #define YY_RULE_SETUP \
YY_USER_ACTION YY_USER_ACTION
/** The main scanner function which does all the work. /*!
* \brief The main scanner function which does all the work.
*/ */
YY_DECL YY_DECL
{ {
@@ -2381,10 +2382,11 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
} }
#endif /* ifndef YY_NO_INPUT */ #endif /* ifndef YY_NO_INPUT */
/** Immediately switch to a different input stream. /*!
* @param input_file A readable stream. * \brief Immediately switch to a different input stream.
* @param yyscanner The scanner object. * \param input_file A readable stream.
* @note This function does not reset the start condition to @c INITIAL . * \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) void ast_yyrestart (FILE * input_file , yyscan_t yyscanner)
{ {
@@ -2400,9 +2402,10 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
ast_yy_load_buffer_state(yyscanner ); ast_yy_load_buffer_state(yyscanner );
} }
/** Switch to a different input buffer. /*!
* @param new_buffer The new input buffer. * \brief Switch to a different input buffer.
* @param yyscanner The scanner object. * \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) void ast_yy_switch_to_buffer (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{ {
@@ -2445,11 +2448,13 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner)
yyg->yy_hold_char = *yyg->yy_c_buf_p; yyg->yy_hold_char = *yyg->yy_c_buf_p;
} }
/** Allocate and initialize an input buffer state. /*!
* @param file A readable stream. * \brief Allocate and initialize an input buffer state.
* @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE. * \param file A readable stream.
* @param yyscanner The scanner object. * \param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE.
* @return the allocated buffer state. * \param yyscanner The scanner object.
*
* \return the allocated buffer state.
*/ */
YY_BUFFER_STATE ast_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner) YY_BUFFER_STATE ast_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner)
{ {
@@ -2475,9 +2480,10 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner)
return b; return b;
} }
/** Destroy the buffer. /*!
* @param b a buffer created with ast_yy_create_buffer() * \brief Destroy the buffer.
* @param yyscanner The scanner object. * \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) void ast_yy_delete_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{ {
@@ -2528,9 +2534,10 @@ extern int isatty (int );
errno = oerrno; 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. * \brief Discard all buffered characters. On the next scan, YY_INPUT will be called.
* @param yyscanner The scanner object. * \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) void ast_yy_flush_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{ {
@@ -2556,11 +2563,12 @@ extern int isatty (int );
ast_yy_load_buffer_state(yyscanner ); ast_yy_load_buffer_state(yyscanner );
} }
/** Pushes the new state onto the stack. The new state becomes /*!
* \brief Pushes the new state onto the stack. The new state becomes
* the current state. This function will allocate the stack * the current state. This function will allocate the stack
* if necessary. * if necessary.
* @param new_buffer The new state. * \param new_buffer The new state.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
*/ */
void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{ {
@@ -2589,9 +2597,10 @@ void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
yyg->yy_did_buffer_switch_on_eof = 1; 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. * 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) void ast_yypop_buffer_state (yyscan_t yyscanner)
{ {
@@ -2653,11 +2662,13 @@ 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 * \brief Setup the input buffer state to scan directly from a user-specified character buffer.
* @param size the size in bytes of the character buffer * \param base the character buffer
* @param yyscanner The scanner object. * \param size the size in bytes of the character buffer
* @return the newly allocated buffer state object. * \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) YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yyscanner)
{ {
@@ -2688,12 +2699,14 @@ YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yys
return b; return b;
} }
/** Setup the input buffer state to scan a string. The next call to ast_yylex() will /*!
* \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. * scan from a @e copy of @a str.
* @param str a NUL-terminated string to scan * \param str a NUL-terminated string to scan
* @param yyscanner The scanner object. * \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 * \return the newly allocated buffer state object.
* \note If you want to scan bytes that may contain NULL values, then use
* ast_yy_scan_bytes() instead. * ast_yy_scan_bytes() instead.
*/ */
YY_BUFFER_STATE ast_yy_scan_string (yyconst char * str , yyscan_t yyscanner) YY_BUFFER_STATE ast_yy_scan_string (yyconst char * str , yyscan_t yyscanner)
@@ -2702,12 +2715,14 @@ YY_BUFFER_STATE ast_yy_scan_string (yyconst char * str , yyscan_t yyscanner)
return ast_yy_scan_bytes(str,strlen(str) ,yyscanner); return ast_yy_scan_bytes(str,strlen(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. * scan from a @e copy of @a bytes.
* @param bytes the byte buffer to scan * \param bytes the byte buffer to scan
* @param len the number of bytes in the buffer pointed to by @a bytes. * \param len the number of bytes in the buffer pointed to by @a bytes.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
* @return the newly allocated buffer state object. *
* \return the newly allocated buffer state object.
*/ */
YY_BUFFER_STATE ast_yy_scan_bytes (yyconst char * bytes, int len , yyscan_t yyscanner) YY_BUFFER_STATE ast_yy_scan_bytes (yyconst char * bytes, int len , yyscan_t yyscanner)
{ {
@@ -2768,8 +2783,9 @@ static void yy_fatal_error (yyconst char* msg , yyscan_t yyscanner)
/* Accessor methods (get/set functions) to struct members. */ /* 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) YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner)
{ {
@@ -2777,8 +2793,9 @@ YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner)
return yyextra; 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) int ast_yyget_lineno (yyscan_t yyscanner)
{ {
@@ -2790,8 +2807,9 @@ int ast_yyget_lineno (yyscan_t yyscanner)
return yylineno; 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) int ast_yyget_column (yyscan_t yyscanner)
{ {
@@ -2803,8 +2821,9 @@ int ast_yyget_column (yyscan_t yyscanner)
return yycolumn; 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) FILE *ast_yyget_in (yyscan_t yyscanner)
{ {
@@ -2812,8 +2831,9 @@ FILE *ast_yyget_in (yyscan_t yyscanner)
return yyin; 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) FILE *ast_yyget_out (yyscan_t yyscanner)
{ {
@@ -2821,8 +2841,9 @@ FILE *ast_yyget_out (yyscan_t yyscanner)
return yyout; 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) int ast_yyget_leng (yyscan_t yyscanner)
{ {
@@ -2830,8 +2851,9 @@ int ast_yyget_leng (yyscan_t yyscanner)
return yyleng; return yyleng;
} }
/** Get the current token. /*!
* @param yyscanner The scanner object. * \brief Get the current token.
* \param yyscanner The scanner object.
*/ */
char *ast_yyget_text (yyscan_t yyscanner) char *ast_yyget_text (yyscan_t yyscanner)
@@ -2840,9 +2862,10 @@ char *ast_yyget_text (yyscan_t yyscanner)
return yytext; 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. * \brief Set the user-defined data. This data is never touched by the scanner.
* @param yyscanner The scanner object. * \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) void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
{ {
@@ -2850,9 +2873,10 @@ void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
yyextra = user_defined ; yyextra = user_defined ;
} }
/** Set the current line number. /*!
* @param line_number * \brief Set the current line number.
* @param yyscanner The scanner object. * \param line_number
* \param yyscanner The scanner object.
*/ */
void ast_yyset_lineno (int line_number , yyscan_t yyscanner) void ast_yyset_lineno (int line_number , yyscan_t yyscanner)
{ {
@@ -2865,9 +2889,10 @@ void ast_yyset_lineno (int line_number , yyscan_t yyscanner)
yylineno = line_number; yylineno = line_number;
} }
/** Set the current column. /*!
* @param line_number * \brief Set the current column.
* @param yyscanner The scanner object. * \param column_no
* \param yyscanner The scanner object.
*/ */
void ast_yyset_column (int column_no , yyscan_t yyscanner) void ast_yyset_column (int column_no , yyscan_t yyscanner)
{ {
@@ -2880,11 +2905,12 @@ void ast_yyset_column (int column_no , yyscan_t yyscanner)
yycolumn = column_no; yycolumn = column_no;
} }
/** Set the input stream. This does not discard the current /*!
* \brief Set the input stream. This does not discard the current
* input buffer. * input buffer.
* @param in_str A readable stream. * \param in_str A readable stream.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
* @see ast_yy_switch_to_buffer * \see ast_yy_switch_to_buffer
*/ */
void ast_yyset_in (FILE * in_str , yyscan_t yyscanner) void ast_yyset_in (FILE * in_str , yyscan_t yyscanner)
{ {
@@ -2969,7 +2995,8 @@ static int yy_init_globals (yyscan_t yyscanner)
/* User-visible API */ /* User-visible API */
/* ast_yylex_init is special because it creates the scanner itself, so it is /*!
* \brief ast_yylex_init is special because it creates the scanner itself, so it is
* the ONLY reentrant function that doesn't take the scanner as the last argument. * the ONLY reentrant function that doesn't take the scanner as the last argument.
* That's why we explicitly handle the declaration, instead of using our macros. * That's why we explicitly handle the declaration, instead of using our macros.
*/ */
@@ -2994,7 +3021,7 @@ int ast_yylex_init(yyscan_t* ptr_yy_globals)
return yy_init_globals ( *ptr_yy_globals ); return yy_init_globals ( *ptr_yy_globals );
} }
/* ast_yylex_destroy is for both reentrant and non-reentrant scanners. */ /*! \brief ast_yylex_destroy is for both reentrant and non-reentrant scanners. */
int ast_yylex_destroy (yyscan_t yyscanner) int ast_yylex_destroy (yyscan_t yyscanner)
{ {
struct yyguts_t * yyg = (struct yyguts_t*)yyscanner; struct yyguts_t * yyg = (struct yyguts_t*)yyscanner;

170
pbx/ael/ael_lex.c
View File

@@ -230,8 +230,8 @@ struct yy_buffer_state
*/ */
int yy_at_bol; int yy_at_bol;
int yy_bs_lineno; /**< The line count. */ int yy_bs_lineno; /*!< The line count. */
int yy_bs_column; /**< The column count. */ int yy_bs_column; /*!< The column count. */
/* Whether to try to fill the input buffer when we reach the /* Whether to try to fill the input buffer when we reach the
* end of it. * end of it.
@@ -899,7 +899,7 @@ static void pbcwhere(const char *text, int *line, int *col )
#define YY_EXTRA_TYPE void * #define YY_EXTRA_TYPE void *
#endif #endif
/* Holds the entire state of the reentrant scanner. */ /*! \brief Holds the entire state of the reentrant scanner. */
struct yyguts_t struct yyguts_t
{ {
@@ -908,9 +908,9 @@ struct yyguts_t
/* The rest are the same as the globals declared in the non-reentrant scanner. */ /* The rest are the same as the globals declared in the non-reentrant scanner. */
FILE *yyin_r, *yyout_r; FILE *yyin_r, *yyout_r;
size_t yy_buffer_stack_top; /**< index of top of stack. */ size_t yy_buffer_stack_top; /*!< index of top of stack. */
size_t yy_buffer_stack_max; /**< capacity of stack. */ size_t yy_buffer_stack_max; /*!< capacity of stack. */
YY_BUFFER_STATE * yy_buffer_stack; /**< Stack as an array. */ YY_BUFFER_STATE * yy_buffer_stack; /*!< Stack as an array. */
char yy_hold_char; char yy_hold_char;
int yy_n_chars; int yy_n_chars;
int yyleng_r; int yyleng_r;
@@ -2176,10 +2176,12 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
} }
#endif /* ifndef YY_NO_INPUT */ #endif /* ifndef YY_NO_INPUT */
/** Immediately switch to a different input stream. /*!
* @param input_file A readable stream. * \brief Immediately switch to a different input stream.
* @param yyscanner The scanner object. * \param input_file A readable stream.
* @note This function does not reset the start condition to @c INITIAL . * \param yyscanner The scanner object.
*
* \note This function does not reset the start condition to @c INITIAL .
*/ */
void ael_yyrestart (FILE * input_file , yyscan_t yyscanner) void ael_yyrestart (FILE * input_file , yyscan_t yyscanner)
{ {
@@ -2195,9 +2197,10 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
ael_yy_load_buffer_state(yyscanner ); ael_yy_load_buffer_state(yyscanner );
} }
/** Switch to a different input buffer. /*!
* @param new_buffer The new input buffer. * \brief Switch to a different input buffer.
* @param yyscanner The scanner object. * \param new_buffer The new input buffer.
* \param yyscanner The scanner object.
*/ */
void ael_yy_switch_to_buffer (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) void ael_yy_switch_to_buffer (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{ {
@@ -2240,11 +2243,13 @@ static void ael_yy_load_buffer_state (yyscan_t yyscanner)
yyg->yy_hold_char = *yyg->yy_c_buf_p; yyg->yy_hold_char = *yyg->yy_c_buf_p;
} }
/** Allocate and initialize an input buffer state. /*!
* @param file A readable stream. * \brief Allocate and initialize an input buffer state.
* @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE. * \param file A readable stream.
* @param yyscanner The scanner object. * \param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE.
* @return the allocated buffer state. * \param yyscanner The scanner object.
*
* \return the allocated buffer state.
*/ */
YY_BUFFER_STATE ael_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner) YY_BUFFER_STATE ael_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner)
{ {
@@ -2270,9 +2275,10 @@ static void ael_yy_load_buffer_state (yyscan_t yyscanner)
return b; return b;
} }
/** Destroy the buffer. /*!
* @param b a buffer created with ael_yy_create_buffer() * \brief Destroy the buffer.
* @param yyscanner The scanner object. * \param b a buffer created with ael_yy_create_buffer()
* \param yyscanner The scanner object.
*/ */
void ael_yy_delete_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner) void ael_yy_delete_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{ {
@@ -2323,9 +2329,10 @@ extern int isatty (int );
errno = oerrno; 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. * \brief Discard all buffered characters. On the next scan, YY_INPUT will be called.
* @param yyscanner The scanner object. * \param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER.
* \param yyscanner The scanner object.
*/ */
void ael_yy_flush_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner) void ael_yy_flush_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{ {
@@ -2351,11 +2358,12 @@ extern int isatty (int );
ael_yy_load_buffer_state(yyscanner ); ael_yy_load_buffer_state(yyscanner );
} }
/** Pushes the new state onto the stack. The new state becomes /*!
* \brief Pushes the new state onto the stack. The new state becomes
* the current state. This function will allocate the stack * the current state. This function will allocate the stack
* if necessary. * if necessary.
* @param new_buffer The new state. * \param new_buffer The new state.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
*/ */
void ael_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner) void ael_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{ {
@@ -2384,9 +2392,10 @@ void ael_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
yyg->yy_did_buffer_switch_on_eof = 1; 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. * The next element becomes the new top.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
*/ */
void ael_yypop_buffer_state (yyscan_t yyscanner) void ael_yypop_buffer_state (yyscan_t yyscanner)
{ {
@@ -2448,11 +2457,13 @@ static void ael_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 * \brief Setup the input buffer state to scan directly from a user-specified character buffer.
* @param size the size in bytes of the character buffer * \param base the character buffer
* @param yyscanner The scanner object. * \param size the size in bytes of the character buffer
* @return the newly allocated buffer state object. * \param yyscanner The scanner object.
*
* \return the newly allocated buffer state object.
*/ */
YY_BUFFER_STATE ael_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yyscanner) YY_BUFFER_STATE ael_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yyscanner)
{ {
@@ -2483,12 +2494,15 @@ YY_BUFFER_STATE ael_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yys
return b; return b;
} }
/** Setup the input buffer state to scan a string. The next call to ael_yylex() will /*!
* \brief Setup the input buffer state to scan a string. The next call to ael_yylex() will
* scan from a @e copy of @a str. * scan from a @e copy of @a str.
* @param str a NUL-terminated string to scan * \param str a NUL-terminated string to scan
* @param yyscanner The scanner object. * \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 * \return the newly allocated buffer state object.
*
* \note If you want to scan bytes that may contain NUL values, then use
* ael_yy_scan_bytes() instead. * ael_yy_scan_bytes() instead.
*/ */
YY_BUFFER_STATE ael_yy_scan_string (yyconst char * str , yyscan_t yyscanner) YY_BUFFER_STATE ael_yy_scan_string (yyconst char * str , yyscan_t yyscanner)
@@ -2497,12 +2511,14 @@ YY_BUFFER_STATE ael_yy_scan_string (yyconst char * str , yyscan_t yyscanner)
return ael_yy_scan_bytes(str,strlen(str) ,yyscanner); return ael_yy_scan_bytes(str,strlen(str) ,yyscanner);
} }
/** Setup the input buffer state to scan the given bytes. The next call to ael_yylex() will /*!
* \brief Setup the input buffer state to scan the given bytes. The next call to ael_yylex() will
* scan from a @e copy of @a bytes. * scan from a @e copy of @a bytes.
* @param bytes the byte buffer to scan * \param bytes the byte buffer to scan
* @param len the number of bytes in the buffer pointed to by @a bytes. * \param len the number of bytes in the buffer pointed to by @a bytes.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
* @return the newly allocated buffer state object. *
* \return the newly allocated buffer state object.
*/ */
YY_BUFFER_STATE ael_yy_scan_bytes (yyconst char * bytes, int len , yyscan_t yyscanner) YY_BUFFER_STATE ael_yy_scan_bytes (yyconst char * bytes, int len , yyscan_t yyscanner)
{ {
@@ -2563,8 +2579,9 @@ static void yy_fatal_error (yyconst char* msg , yyscan_t yyscanner)
/* Accessor methods (get/set functions) to struct members. */ /* 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 ael_yyget_extra (yyscan_t yyscanner) YY_EXTRA_TYPE ael_yyget_extra (yyscan_t yyscanner)
{ {
@@ -2572,8 +2589,9 @@ YY_EXTRA_TYPE ael_yyget_extra (yyscan_t yyscanner)
return yyextra; return yyextra;
} }
/** Get the current line number. /*!
* @param yyscanner The scanner object. * \brief Get the current line number.
* \param yyscanner The scanner object.
*/ */
int ael_yyget_lineno (yyscan_t yyscanner) int ael_yyget_lineno (yyscan_t yyscanner)
{ {
@@ -2585,8 +2603,9 @@ int ael_yyget_lineno (yyscan_t yyscanner)
return yylineno; return yylineno;
} }
/** Get the current column number. /*!
* @param yyscanner The scanner object. * \brief Get the current column number.
* \param yyscanner The scanner object.
*/ */
int ael_yyget_column (yyscan_t yyscanner) int ael_yyget_column (yyscan_t yyscanner)
{ {
@@ -2598,8 +2617,9 @@ int ael_yyget_column (yyscan_t yyscanner)
return yycolumn; return yycolumn;
} }
/** Get the input stream. /*!
* @param yyscanner The scanner object. * \brief Get the input stream.
* \param yyscanner The scanner object.
*/ */
FILE *ael_yyget_in (yyscan_t yyscanner) FILE *ael_yyget_in (yyscan_t yyscanner)
{ {
@@ -2607,8 +2627,9 @@ FILE *ael_yyget_in (yyscan_t yyscanner)
return yyin; return yyin;
} }
/** Get the output stream. /*!
* @param yyscanner The scanner object. * \brief Get the output stream.
* \param yyscanner The scanner object.
*/ */
FILE *ael_yyget_out (yyscan_t yyscanner) FILE *ael_yyget_out (yyscan_t yyscanner)
{ {
@@ -2616,8 +2637,9 @@ FILE *ael_yyget_out (yyscan_t yyscanner)
return yyout; 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 ael_yyget_leng (yyscan_t yyscanner) int ael_yyget_leng (yyscan_t yyscanner)
{ {
@@ -2625,8 +2647,9 @@ int ael_yyget_leng (yyscan_t yyscanner)
return yyleng; return yyleng;
} }
/** Get the current token. /*!
* @param yyscanner The scanner object. * \brief Get the current token.
* \param yyscanner The scanner object.
*/ */
char *ael_yyget_text (yyscan_t yyscanner) char *ael_yyget_text (yyscan_t yyscanner)
@@ -2635,9 +2658,10 @@ char *ael_yyget_text (yyscan_t yyscanner)
return yytext; 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. * \brief Set the user-defined data. This data is never touched by the scanner.
* @param yyscanner The scanner object. * \param user_defined The data to be associated with this scanner.
* \param yyscanner The scanner object.
*/ */
void ael_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner) void ael_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
{ {
@@ -2645,9 +2669,10 @@ void ael_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
yyextra = user_defined ; yyextra = user_defined ;
} }
/** Set the current line number. /*!
* @param line_number * \brief Set the current line number.
* @param yyscanner The scanner object. * \param line_number
* \param yyscanner The scanner object.
*/ */
void ael_yyset_lineno (int line_number , yyscan_t yyscanner) void ael_yyset_lineno (int line_number , yyscan_t yyscanner)
{ {
@@ -2660,9 +2685,10 @@ void ael_yyset_lineno (int line_number , yyscan_t yyscanner)
yylineno = line_number; yylineno = line_number;
} }
/** Set the current column. /*!
* @param line_number * \brief Set the current column.
* @param yyscanner The scanner object. * \param line_number
* \param yyscanner The scanner object.
*/ */
void ael_yyset_column (int column_no , yyscan_t yyscanner) void ael_yyset_column (int column_no , yyscan_t yyscanner)
{ {
@@ -2675,11 +2701,13 @@ void ael_yyset_column (int column_no , yyscan_t yyscanner)
yycolumn = column_no; yycolumn = column_no;
} }
/** Set the input stream. This does not discard the current /*!
* \brief Set the input stream. This does not discard the current
* input buffer. * input buffer.
* @param in_str A readable stream. * \param in_str A readable stream.
* @param yyscanner The scanner object. * \param yyscanner The scanner object.
* @see ael_yy_switch_to_buffer *
* \see ael_yy_switch_to_buffer
*/ */
void ael_yyset_in (FILE * in_str , yyscan_t yyscanner) void ael_yyset_in (FILE * in_str , yyscan_t yyscanner)
{ {