[FFmpeg-devel] [PATCH] Document put_bits_count()

[Stefano Sabatini]

On date Friday 2009-04-10 19:41:55 +0200, Michael Niedermayer encoded:
> On Fri, Apr 10, 2009 at 07:35:30PM +0200, Stefano Sabatini wrote:
> > On date Friday 2009-04-10 18:59:36 +0200, Michael Niedermayer encoded:
> > > On Fri, Apr 10, 2009 at 05:09:54PM +0200, Stefano Sabatini wrote:
> > > > Hi, as in subject.
> > > > -- 
> > > > FFmpeg = Funny & Faithless Magical Philosophical Entertaining Generator
> > > 
> > > > Index: ffmpeg/libavcodec/bitstream.h
> > > > ===================================================================
> > > > --- ffmpeg.orig/libavcodec/bitstream.h	2009-04-10 17:08:23.000000000 +0200
> > > > +++ ffmpeg/libavcodec/bitstream.h	2009-04-10 17:08:43.000000000 +0200
> > > > @@ -116,7 +116,9 @@
> > > >  #endif
> > > >  }
> > > >  
> > > > -/* return the number of bits output */
> > > > +/**
> > > > + * Returns the number of bits put in output.
> > > > + */
> > > 
> > > this sounds strange
> > > please just doxyfy it dont change it
> > 
> > Done, but the original sounds even stranger to me.
> > 
> > I'm attaching doxygenation+doxy-fix patches.
> > 
> > Regards.
> > -- 
> > FFmpeg = Fierce Foolish MultiPurpose Ecumenical Gargoyle
> 
> > Index: ffmpeg/libavcodec/bitstream.h
> > ===================================================================
> > --- ffmpeg.orig/libavcodec/bitstream.h	2009-04-10 19:29:10.000000000 +0200
> > +++ ffmpeg/libavcodec/bitstream.h	2009-04-10 19:31:45.000000000 +0200
> > @@ -116,7 +116,9 @@
> >  #endif
> >  }
> >  
> > -/* return the number of bits output */
> > +/**
> > + * Returns the number of bits output.
> > + */
> >  static inline int put_bits_count(PutBitContext *s)
> >  {
> >  #ifdef ALT_BITSTREAM_WRITER
> 
> ok

Applied.

I'll resend the second patch in a separate thread.

Regards.
-- 
FFmpeg = Fiendish and Foolish Mythic Puristic Egregious Glue