[FFmpeg-devel] [PATCH] Document opt.h:av_set_string functions

Stefano Sabatini stefano.sabatini-lala
Tue Jul 22 02:15:05 CEST 2008


On date Monday 2008-07-21 19:09:42 -0400, The Wanderer encoded:
> Stefano Sabatini wrote:
> 
> > On date Monday 2008-07-21 06:41:09 -0400, The Wanderer encoded:
> 
> >> I understood what it meant; "In a similar way, prefixing a flag
> >> with '-' causes it to be unset without affecting the other flags".
> >> The less verbose form is understandable and less clunky IMO. This
> >> should, however, be a separate 'sentence', split off by either a
> >> period or a semicolon.
> > 
> > Fixed with a semicolon.

Added the comma.

> One thing I forgot to mention: there should also be a comma after the
> "similarly". (Strictly speaking it belongs there even in your original
> form, but it would look awkward with a comma before the word as well.)
> 
> Also, as long as I'm glancing over the entire patch rather than just
> someone else's quote of it: there should be a comma before the " or
> NULL" in the return-value explanation.

Yes, also more consistent with av_find_opt() docs (but not with the rest
of the FFmpeg doxygenation!!!, I hope this won't end up in a Comma
Holy War, so I leave the final decision to Diego). 

> Other than that, this looks good to me.
> 
> > PS Diego, I can't figure out what you mean with <complaint
> > type="standard">,
> 
> For what it's worth, in a little time spent considering the question I
> wasn't able to figure it out either.

Regards.
-- 
FFmpeg = Free and Funny Merciless Portable Elegant Guide
-------------- next part --------------
A non-text attachment was scrubbed...
Name: document-av-set-string-04.patch
Type: text/x-diff
Size: 1526 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20080722/6a5ec18c/attachment.patch>



More information about the ffmpeg-devel mailing list