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

[Stefano Sabatini]

On date Wednesday 2008-07-23 10:20:51 +0200, Diego Biurrun encoded:
> On Tue, Jul 22, 2008 at 02:15:05AM +0200, Stefano Sabatini wrote:
> > On date Monday 2008-07-21 19:09:42 -0400, The Wanderer encoded:
> > > 
> > > 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). 
> 
> Yes, there should be a comma.
> 
> > --- libavcodec/opt.h	(revision 14329)
> > +++ libavcodec/opt.h	(working copy)
> > @@ -99,10 +99,30 @@
> >  
> > + * @param[in] obj a struct whose first element is a pointer to an
> > + * AVClass
> 
> This is a complete sentence.

It depends on what you mean with complete sentence, e.g.:
a dog

we agree that it isn't a complete sentence, but for:
a dog, which is a barking animal

I still consider it an incomplete sentence, since the subject "dog"
doesn't have a corresponding verb.

Fixed anyway (although inconsistent with the capitalization rule
applied for the av_find_opt() doxy).

> > + * @param[in] name the name of the field to set
> > + * @param[in] val The value to set. If the field is not of a string
> > + * type, then the given string is parsed.
> 
> For one param you capitalize, for one you do not.

This is a style issue never resolved, see for example:
http://thread.gmane.org/20080607084902.GA13803 at geppetto

but I think I did it right, since "it is an incomplete sentence
followed by a complete sentence".

Regards.
-- 
FFmpeg = Friendly and Furious Mega Portable Exuberant Game
-------------- next part --------------
A non-text attachment was scrubbed...
Name: document-av-set-string-05.patch
Type: text/x-diff
Size: 1527 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20080723/e18a23ac/attachment.patch>