Fix a few doxygen warnings.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@38009 f38db490-d61c-443f-a65b-d21fe96a405b
This commit is contained in:
parent
e0a9b2f295
commit
3898789c02
|
@ -2722,8 +2722,8 @@ YY_BUFFER_STATE ast_yy_scan_string (yyconst char * yystr , yyscan_t yyscanner)
|
|||
|
||||
/** 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 yybytes the byte buffer to scan
|
||||
* @param _yybytes_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.
|
||||
*/
|
||||
|
@ -2884,7 +2884,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)
|
||||
|
|
|
@ -6739,7 +6739,7 @@ static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *messa
|
|||
return send_request(p, &req, 1, p->ocseq);
|
||||
}
|
||||
|
||||
/*! \build Convert registration state status to string */
|
||||
/*! \brief Convert registration state status to string */
|
||||
static char *regstate2str(enum sipregistrystate regstate)
|
||||
{
|
||||
switch(regstate) {
|
||||
|
|
|
@ -85,7 +85,7 @@ struct vorbis_desc { /* format specific parameters */
|
|||
|
||||
/*!
|
||||
* \brief Create a new OGG/Vorbis filestream and set it up for reading.
|
||||
* \param f File that points to on disk storage of the OGG/Vorbis data.
|
||||
* \param s File that points to on disk storage of the OGG/Vorbis data.
|
||||
* \return The new filestream.
|
||||
*/
|
||||
static int ogg_vorbis_open(struct ast_filestream *s)
|
||||
|
@ -195,7 +195,7 @@ error:
|
|||
|
||||
/*!
|
||||
* \brief Create a new OGG/Vorbis filestream and set it up for writing.
|
||||
* \param f File pointer that points to on-disk storage.
|
||||
* \param s File pointer that points to on-disk storage.
|
||||
* \param comment Comment that should be embedded in the OGG/Vorbis file.
|
||||
* \return A new filestream.
|
||||
*/
|
||||
|
@ -272,7 +272,7 @@ static void write_stream(struct vorbis_desc *s, FILE *f)
|
|||
|
||||
/*!
|
||||
* \brief Write audio data from a frame to an OGG/Vorbis filestream.
|
||||
* \param s A OGG/Vorbis filestream.
|
||||
* \param fs A OGG/Vorbis filestream.
|
||||
* \param f An frame containing audio to be written to the filestream.
|
||||
* \return -1 ifthere was an error, 0 on success.
|
||||
*/
|
||||
|
@ -316,7 +316,7 @@ static int ogg_vorbis_write(struct ast_filestream *fs, struct ast_frame *f)
|
|||
|
||||
/*!
|
||||
* \brief Close a OGG/Vorbis filestream.
|
||||
* \param s A OGG/Vorbis filestream.
|
||||
* \param fs A OGG/Vorbis filestream.
|
||||
*/
|
||||
static void ogg_vorbis_close(struct ast_filestream *fs)
|
||||
{
|
||||
|
@ -342,7 +342,7 @@ static void ogg_vorbis_close(struct ast_filestream *fs)
|
|||
|
||||
/*!
|
||||
* \brief Get audio data.
|
||||
* \param s An OGG/Vorbis filestream.
|
||||
* \param fs An OGG/Vorbis filestream.
|
||||
* \param pcm Pointer to a buffere to store audio data in.
|
||||
*/
|
||||
|
||||
|
@ -421,7 +421,7 @@ static int read_samples(struct ast_filestream *fs, float ***pcm)
|
|||
|
||||
/*!
|
||||
* \brief Read a frame full of audio data from the filestream.
|
||||
* \param s The filestream.
|
||||
* \param fs The filestream.
|
||||
* \param whennext Number of sample times to schedule the next call.
|
||||
* \return A pointer to a frame containing audio data or NULL ifthere is no more audio data.
|
||||
*/
|
||||
|
|
|
@ -137,7 +137,7 @@ int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, in
|
|||
/*!
|
||||
* \brief Puts a frame into a channel jitterbuffer.
|
||||
* \param chan channel.
|
||||
* \param frame frame.
|
||||
* \param f frame.
|
||||
*
|
||||
* Called from ast_generic_bridge() to put a frame into a channel's jitterbuffer.
|
||||
* The function will successfuly enqueue a frame if and only if:
|
||||
|
|
Reference in New Issue