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

[Stefano Sabatini]

On date Wednesday 2010-02-03 00:34:16 +0100, Stefano Sabatini encoded:
> On date Monday 2010-02-01 19:49:04 +0100, Stefano Sabatini encoded:
> > On date Saturday 2010-01-30 23:17:10 +0100, Stefano Sabatini encoded:
> > > On date Saturday 2010-01-30 22:43:46 +0100, Reimar D?ffinger encoded:
> > > > On Sat, Jan 30, 2010 at 10:32:50PM +0100, Stefano Sabatini wrote:
> > > > > On date Saturday 2010-01-30 21:28:53 +0100, Reimar D?ffinger encoded:
> > > > > > On Sat, Jan 30, 2010 at 09:08:55PM +0100, Stefano Sabatini wrote:
> > > > > > > +/**
> > > > > > > + * Creates and initializes a ByteIOContext for accessing the
> > > > > > > + * resource referenced by the URLContext h.
> > > > > > > + * In case of success puts the pointer to the created ByteIOContext in
> > > > > > > + * *s, otherwise sets *s to NULL.
> > > > > > 
> > > > > > Maybe make that paragraph into an @param s
> > > > > 
> > > > > Turning this into a description it would be:
> > > > > 
> > > > > @param s pointer to the location where, in case of success, the
> > > > > function puts the pointer to the created ByteIOContext; in case of
> > > > > failure *s is set to NULL.
> > > > 
> > > > @param s used to return the pointer to the created ByteIOContext; set to NULL
> > > > in case of an error (return value <  0).
> > > 
> > > I don't like the second part, "set to NULL" may be confusing, it is *s
> > > which is set to NULL), so that should be:
> > > 
> > > @param s used to return the pointer to the created ByteIOContext; the
> > > pointed to value is set to NULL in case of an error
> > > 
> > > which is slightly more verbose and which I found slightly less clear.
> > > 
> > > Attaching another variant, I have a slight preference for the previous
> > > one though.
> > 
> > Ping, this or the previous variant is OK for me.
> 
> If no one will step against I'll commit one of the variant in three
> days.

Applied.
-- 
FFmpeg = Funny and Faithless Martial Practical Encoding/decoding Guru