kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-29 18:19:30 +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

170
pbx/ael/ael_lex.c
View File

@@ -230,8 +230,8 @@ struct yy_buffer_state
*/
int yy_at_bol;
int yy_bs_lineno; /**< The line count. */
int yy_bs_column; /**< The column count. */
int yy_bs_lineno; /*!< The line count. */
int yy_bs_column; /*!< The column count. */
/* Whether to try to fill the input buffer when we reach the
* end of it.
@@ -899,7 +899,7 @@ static void pbcwhere(const char *text, int *line, int *col )
#define YY_EXTRA_TYPE void *
#endif
/* Holds the entire state of the reentrant scanner. */
/*! \brief Holds the entire state of the reentrant scanner. */
struct yyguts_t
{
@@ -908,9 +908,9 @@ struct yyguts_t
/* The rest are the same as the globals declared in the non-reentrant scanner. */
FILE *yyin_r, *yyout_r;
size_t yy_buffer_stack_top; /**< index of top of stack. */
size_t yy_buffer_stack_max; /**< capacity of stack. */
YY_BUFFER_STATE * yy_buffer_stack; /**< Stack as an array. */
size_t yy_buffer_stack_top; /*!< index of top of stack. */
size_t yy_buffer_stack_max; /*!< capacity of stack. */
YY_BUFFER_STATE * yy_buffer_stack; /*!< Stack as an array. */
char yy_hold_char;
int yy_n_chars;
int yyleng_r;
@@ -2176,10 +2176,12 @@ 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 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 );
}
/** 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 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;
}
/** 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 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;
}
/** Destroy the buffer.
* @param b a buffer created with ael_yy_create_buffer()
* @param yyscanner The scanner object.
/*!
* \brief Destroy the buffer.
* \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)
{
@@ -2323,9 +2329,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 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 );
}
/** 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
* if necessary.
* @param new_buffer The new state.
* @param yyscanner The scanner object.
* \param new_buffer The new state.
* \param yyscanner The scanner object.
*/
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;
}
/** 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 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
* @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 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;
}
/** 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.
* @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
* \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
* ael_yy_scan_bytes() instead.
*/
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);
}
/** 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.
* @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 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. */
/** 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)
{
@@ -2572,8 +2589,9 @@ YY_EXTRA_TYPE ael_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 ael_yyget_lineno (yyscan_t yyscanner)
{
@@ -2585,8 +2603,9 @@ int ael_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 ael_yyget_column (yyscan_t yyscanner)
{
@@ -2598,8 +2617,9 @@ int ael_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 *ael_yyget_in (yyscan_t yyscanner)
{
@@ -2607,8 +2627,9 @@ FILE *ael_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 *ael_yyget_out (yyscan_t yyscanner)
{
@@ -2616,8 +2637,9 @@ FILE *ael_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 ael_yyget_leng (yyscan_t yyscanner)
{
@@ -2625,8 +2647,9 @@ int ael_yyget_leng (yyscan_t yyscanner)
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)
@@ -2635,9 +2658,10 @@ char *ael_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 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 ;
}
/** 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 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;
}
/** Set the current column.
* @param line_number
* @param yyscanner The scanner object.
/*!
* \brief Set the current column.
* \param line_number
* \param yyscanner The scanner object.
*/
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;
}
/** Set the input stream. This does not discard the current
/*!
* \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 ael_yy_switch_to_buffer
* \param in_str A readable stream.
* \param yyscanner The scanner object.
*
* \see ael_yy_switch_to_buffer
*/
void ael_yyset_in (FILE * in_str , yyscan_t yyscanner)
{