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

[Stefano Sabatini]

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.

Regards.
-- 
FFmpeg = Frenzy and Furious Mythic Power Exploitable Guru
-------------- next part --------------
A non-text attachment was scrubbed...
Name: avio-document-url-fdopen.patch
Type: text/x-diff
Size: 954 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100130/5cd84dde/attachment.patch>