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

[Stefano Sabatini]

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.

Maybe you can reword that and make it more clear, but this is a case
where it looks more direct and clear just to say what the function
*does* with it, rather than saying *what* it is.

> > + * @note When the URLContext h has been opened in read+write mode, the
> > + * ByteIOContext can be used only for writing.
> 
> Ah, now it makes sense :-)
> 
> > + * @return 0 in case of success, a negative value corresponding to an
> > + * AVERROR code in case of failure
> 
> Seems a bit verbose, but I have no really good suggestion.
> Looks ok to me otherwise.

Regards.
-- 
FFmpeg = Friendly & Fantastic Mastodontic Patchable Ephemeral Guru