Avoid square brackets in Doxygen comments; Doxygen chokes on them.
Originally committed as revision 23979 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
parent
b8ab52e702
commit
3fa7626863
@ -44,8 +44,8 @@ typedef struct {
|
|||||||
* Parse AAC frame header.
|
* Parse AAC frame header.
|
||||||
* Parse the ADTS frame header to the end of the variable header, which is
|
* Parse the ADTS frame header to the end of the variable header, which is
|
||||||
* the first 54 bits.
|
* the first 54 bits.
|
||||||
* @param gbc[in] BitContext containing the first 54 bits of the frame.
|
* @param gbc BitContext containing the first 54 bits of the frame.
|
||||||
* @param hdr[out] Pointer to struct where header info is written.
|
* @param hdr Pointer to struct where header info is written.
|
||||||
* @return Returns 0 on success, -1 if there is a sync word mismatch,
|
* @return Returns 0 on success, -1 if there is a sync word mismatch,
|
||||||
* -2 if the version element is invalid, -3 if the sample rate
|
* -2 if the version element is invalid, -3 if the sample rate
|
||||||
* element is invalid, or -4 if the bit rate element is invalid.
|
* element is invalid, or -4 if the bit rate element is invalid.
|
||||||
|
@ -30,8 +30,8 @@
|
|||||||
* Parse AC-3 frame header.
|
* Parse AC-3 frame header.
|
||||||
* Parse the header up to the lfeon element, which is the first 52 or 54 bits
|
* Parse the header up to the lfeon element, which is the first 52 or 54 bits
|
||||||
* depending on the audio coding mode.
|
* depending on the audio coding mode.
|
||||||
* @param gbc[in] BitContext containing the first 54 bits of the frame.
|
* @param gbc BitContext containing the first 54 bits of the frame.
|
||||||
* @param hdr[out] Pointer to struct where header info is written.
|
* @param hdr Pointer to struct where header info is written.
|
||||||
* @return Returns 0 on success, -1 if there is a sync word mismatch,
|
* @return Returns 0 on success, -1 if there is a sync word mismatch,
|
||||||
* -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
|
* -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
|
||||||
* element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
|
* element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
|
||||||
@ -43,8 +43,8 @@ int ff_ac3_parse_header(GetBitContext *gbc, AC3HeaderInfo *hdr);
|
|||||||
* Parse the header up to the lfeon (channel_map in E-AC-3)
|
* Parse the header up to the lfeon (channel_map in E-AC-3)
|
||||||
* element, which is the first 52, 54 or 104 bits depending
|
* element, which is the first 52, 54 or 104 bits depending
|
||||||
* on the audio coding mode.
|
* on the audio coding mode.
|
||||||
* @param gbc[in] BitContext containing the first 54 bits of the frame.
|
* @param gbc BitContext containing the first 54 bits of the frame.
|
||||||
* @param hdr[out] Pointer to struct where header info is written.
|
* @param hdr Pointer to struct where header info is written.
|
||||||
* @return value returned by ff_ac3_parse_header
|
* @return value returned by ff_ac3_parse_header
|
||||||
*/
|
*/
|
||||||
int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr);
|
int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr);
|
||||||
|
@ -46,7 +46,7 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in
|
|||||||
* Omitting this step creates audible distortion on the sinusoidal sweep
|
* Omitting this step creates audible distortion on the sinusoidal sweep
|
||||||
* test vectors in 3GPP TS 26.074.
|
* test vectors in 3GPP TS 26.074.
|
||||||
*
|
*
|
||||||
* @param[in,out] lsf LSFs in Hertz
|
* @param lsf [in,out] LSFs in Hertz
|
||||||
* @param min_spacing minimum distance between two consecutive lsf values
|
* @param min_spacing minimum distance between two consecutive lsf values
|
||||||
*/
|
*/
|
||||||
void ff_set_min_dist_lsf(float *lsf, double min_spacing, int order);
|
void ff_set_min_dist_lsf(float *lsf, double min_spacing, int order);
|
||||||
|
@ -1028,7 +1028,7 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\param P[10][2] a list of candidate mvs to check before starting the
|
\param P a list of candidate mvs to check before starting the
|
||||||
iterative search. If one of the candidates is close to the optimal mv, then
|
iterative search. If one of the candidates is close to the optimal mv, then
|
||||||
it takes fewer iterations. And it increases the chance that we find the
|
it takes fewer iterations. And it increases the chance that we find the
|
||||||
optimal mv.
|
optimal mv.
|
||||||
|
@ -747,8 +747,7 @@ static void decode_mb_mode(VP8Context *s, VP8Macroblock *mb, int mb_x, int mb_y,
|
|||||||
* @param i initial coeff index, 0 unless a separate DC block is coded
|
* @param i initial coeff index, 0 unless a separate DC block is coded
|
||||||
* @param zero_nhood the initial prediction context for number of surrounding
|
* @param zero_nhood the initial prediction context for number of surrounding
|
||||||
* all-zero blocks (only left/top, so 0-2)
|
* all-zero blocks (only left/top, so 0-2)
|
||||||
* @param qmul[0] dc dequant factor
|
* @param qmul array holding the dc/ac dequant factor at position 0/1
|
||||||
* @param qmul[1] ac dequant factor
|
|
||||||
* @return 0 if no coeffs were decoded
|
* @return 0 if no coeffs were decoded
|
||||||
* otherwise, the index of the last coeff decoded plus one
|
* otherwise, the index of the last coeff decoded plus one
|
||||||
*/
|
*/
|
||||||
|
@ -55,7 +55,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
|
|||||||
* Get the next two numbers generated by a Box-Muller Gaussian
|
* Get the next two numbers generated by a Box-Muller Gaussian
|
||||||
* generator using the random numbers issued by lfg.
|
* generator using the random numbers issued by lfg.
|
||||||
*
|
*
|
||||||
* @param out[2] array where are placed the two generated numbers
|
* @param out array where the two generated numbers are placed
|
||||||
*/
|
*/
|
||||||
void av_bmg_get(AVLFG *lfg, double out[2]);
|
void av_bmg_get(AVLFG *lfg, double out[2]);
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user