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

Stefano Sabatini stefano.sabatini-lala
Mon Apr 13 22:02:45 CEST 2009


On date Saturday 2009-04-11 16:08:01 +0200, Michael Niedermayer encoded:
> On Sat, Apr 11, 2009 at 03:17:20PM +0200, Stefano Sabatini wrote:
> > On date Saturday 2009-04-11 14:34:24 +0200, Michael Niedermayer encoded:
> > > On Sat, Apr 11, 2009 at 11:57:42AM +0200, Stefano Sabatini wrote:
> > > > Hi, as in subject.
> > > > -- 
> > > > FFmpeg = Frightening and Fierce MultiPurpose Enlightened Gospel
> > > 
> > > > Index: ffmpeg/libavcodec/bitstream.h
> > > > ===================================================================
> > > > --- ffmpeg.orig/libavcodec/bitstream.h	2009-04-11 11:56:15.000000000 +0200
> > > > +++ ffmpeg/libavcodec/bitstream.h	2009-04-11 11:56:45.000000000 +0200
> > > > @@ -175,6 +175,10 @@
> > > >   */
> > > >  void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
> > > >  
> > > > +/**
> > > > + * Puts in the PutBitContext \p s \p n bits corresponding to the value
> > > > + * \p value.
> > > > + */
> > > 
> > > do you mind removing all \p from ffmpeg ?
> > 
> > This has been already discussed, I'm slighlty in favor of using more
> > markup in the docs since it improves doxygen rendering, sometimes it
> > makes more clear plain text docs, IIRC also Diego preferred it.
> 
> it makes the actual comments in the code less readable
> i think more people read the code then generated doxy

Diego, what's your position?

And patch simplified and updated.

Regards.
-- 
FFmpeg = Faithful & Friendly Merciless Proud Elastic Gorilla
-------------- next part --------------
A non-text attachment was scrubbed...
Name: bs-document-put-bits.patch
Type: text/x-diff
Size: 538 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090413/d5200c0a/attachment.patch>



More information about the ffmpeg-devel mailing list