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

[Reimar Döffinger]

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).