On Sun, Nov 06, 2011 at 03:23:39PM +0100, Reinhard Tartler wrote:
> On Sun, Oct 30, 2011 at 10:08 PM, Diego Biurrun <[email protected]> wrote:
> >
> > --- a/libavcodec/amrnbdec.c
> > +++ b/libavcodec/amrnbdec.c
> > @@ -649,7 +649,7 @@ static void decode_gains(AMRContext *p, const 
> > AMRNBSubframe *amr_subframe,
> >  static void apply_ir_filter(float *out, const AMRFixed *in,
> >                             const float *filter)
> >  {
> > -    float filter1[AMR_SUBFRAME_SIZE],     //!< filters at pitch lag*1 and 
> > *2
> > +    float filter1[AMR_SUBFRAME_SIZE],     ///< filters at pitch lag*1 and 
> > *2
> 
> As far as I understand it according to
> http://www.stack.nl/~dimitri/doxygen/docblocks.html, the correct
> Qt-like Doxygen style would be:
> 
> /*!<  filters at pitch lag*1 and *2 */
> 
> or
> 
> //!< filters at pitch lag*1 and *2
> 
> In that case, this patch would be inconsistent to its description.

I was under the impression that all uses of '!' in Doxygen originate
from Qt.

> Besides, if we really cared about doxygen style consistency, I think
> we should a) document it in the tree, and b) make tools/patchcheck
> check for this.

That's slightly out of scope here, but I'll patch the developer docs.

> > --- a/libavcodec/ivi_common.h
> > +++ b/libavcodec/ivi_common.h
> > @@ -51,7 +51,7 @@ typedef struct {
> >                             /// or "7" for custom one
> >     VLC         *tab;       /// pointer to the table associated with tab_sel
> >
> > -    //! the following are used only when tab_sel == 7
> > +    /// the following are used only when tab_sel == 7
> 
> Again, AFAIUI this is not Qt-like style, but a third, C++-style variant.

see above

> BTW, are comments starting with '//' legal C? I thought it was a GNU
> extension that almost every C compiler adopted.

It's C99.

> > --- a/libavcodec/mlpdec.c
> > +++ b/libavcodec/mlpdec.c
> > @@ -45,35 +45,35 @@ static const char* sample_message =
> >     "a sample of this file.";
> >
> >  typedef struct SubStream {
> > -    //! Set if a valid restart header has been read. Otherwise the 
> > substream cannot be decoded.
> > +    /// Set if a valid restart header has been read. Otherwise the 
> > substream cannot be decoded.
> >     uint8_t     restart_seen;
> 
> 
> Did you find these occurances by hand or did you use a script? If the
> latter, I'd rather review the script as well.

I used git-grep and sed.

Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to