[FFmpeg-devel] [PATCH] Document url_fdopen()
Sat Jan 30 21:08:55 CET 2010
On date Saturday 2010-01-30 15:50:35 +0100, Reimar D?ffinger encoded:
> On Sat, Jan 30, 2010 at 01:24:17PM +0100, Stefano Sabatini wrote:
> > > +/**
> > > + * Creates and initializes a ByteIOContext for accessing to the
> > > + * resource accessed by the url context h.
> "accessing to" is not proper grammar.
> The second "accessed" IMO is confusing. Maybe "referenced"?
> Or maybe "Creates a ByteIOContext wrapping the URLContext h"?
Yes I used "referenced", as I believe the expression "wrapping the
URLContext h" is too vague.
> > > + * @note When opened as read/write, the buffers are only used for
> > > + * writing.
> Which buffers?
> In how for is that relevant to someone using that function, what
> difference does it make?
> > > + * @param s pointer to the location where, in case of success, the
> > > + * function puts the pointer to the created ByteIOContext
> Either explain what happens in case of non-success or just don't mention it.
> Really the only interesting things for a user are
> a) do you have to free that thing when the call fails?
> b) do I have to check the return value or is checking this for != NULL enough?
Please check again.
Thanks for the review, regards.
FFmpeg = Fundamentalist and Fundamentalist Multimedia Ponderous Excellent Gospel
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 931 bytes
Desc: not available
More information about the ffmpeg-devel