[FFmpeg-cvslog] r23979 - in trunk: libavcodec/aac_parser.h libavcodec/ac3_parser.h libavcodec/lsp.h libavcodec/motion_est_template.c libavcodec/vp8.c libavutil/lfg.h

[Michael Niedermayer]

On Fri, Jul 02, 2010 at 01:44:58PM +0200, diego wrote:
> Author: diego
> Date: Fri Jul  2 13:44:58 2010
> New Revision: 23979
> 
> Log:
> Avoid square brackets in Doxygen comments; Doxygen chokes on them.
> 
> Modified:
>    trunk/libavcodec/aac_parser.h
>    trunk/libavcodec/ac3_parser.h
>    trunk/libavcodec/lsp.h
>    trunk/libavcodec/motion_est_template.c
>    trunk/libavcodec/vp8.c
>    trunk/libavutil/lfg.h
> 
> Modified: trunk/libavcodec/aac_parser.h
> ==============================================================================
> --- trunk/libavcodec/aac_parser.h	Fri Jul  2 13:41:13 2010	(r23978)
> +++ trunk/libavcodec/aac_parser.h	Fri Jul  2 13:44:58 2010	(r23979)
> @@ -44,8 +44,8 @@ typedef struct {
>   * Parse AAC frame header.
>   * Parse the ADTS frame header to the end of the variable header, which is
>   * the first 54 bits.
> - * @param gbc[in] BitContext containing the first 54 bits of the frame.
> - * @param hdr[out] Pointer to struct where header info is written.
> + * @param gbc BitContext containing the first 54 bits of the frame.
> + * @param hdr Pointer to struct where header info is written.
>   * @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
>   * element is invalid, or -4 if the bit rate element is invalid.
> 
> Modified: trunk/libavcodec/ac3_parser.h
> ==============================================================================
> --- trunk/libavcodec/ac3_parser.h	Fri Jul  2 13:41:13 2010	(r23978)
> +++ trunk/libavcodec/ac3_parser.h	Fri Jul  2 13:44:58 2010	(r23979)
> @@ -30,8 +30,8 @@
>   * Parse AC-3 frame header.
>   * Parse the header up to the lfeon element, which is the first 52 or 54 bits
>   * depending on the audio coding mode.
> - * @param gbc[in] BitContext containing the first 54 bits of the frame.
> - * @param hdr[out] Pointer to struct where header info is written.
> + * @param gbc BitContext containing the first 54 bits of the frame.
> + * @param hdr Pointer to struct where header info is written.
>   * @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)
>   * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.

whatever doxygen does, the information in the square brackets is an integral
part of the documentation and simply removing it is reducing the readability
and understandablity of them.
Please revert this!

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

I do not agree with what you have to say, but I'll defend to the death your
right to say it. -- Voltaire
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-cvslog/attachments/20100702/dd567e6a/attachment.pgp>