[FFmpeg-devel] [PATCH] Document libavcodec/opt.h

[The Wanderer]

Stefano Sabatini wrote:

> On date Friday 2008-06-06 11:23:37 +0200, Diego Biurrun encoded:
> 
>> On Fri, Jun 06, 2008 at 01:08:57AM +0200, Stefano Sabatini wrote:

>>> --- libavcodec/opt.h	(revision 13667)
>>> +++ libavcodec/opt.h	(working copy)
>>> @@ -45,19 +57,36 @@
>>>  typedef struct AVOption {
>>> +    /**
>>> +     * the name of the option, it should be unique amongst the options
>>> +     * contained in an AVClass object<br>
>> 
>> Capitalize, end in a period.
> 
> Diego, in this case we have a nominal followed by a complete
> sentence, so I'm not really sure which rule to apply.
> My solution is:
> 
>  * name the name of the option<br>
>  * It should be unique amongst the options contained in an AVClass
>  * object.
> 
> Hope you like it ;-).

I would drop the "It" (and, if unintentional, the first word of "name
the name"), but otherwise this looks like about the best which can be
done under the rules at hand, short of rephrasing to eliminate the
two-sections form.

-- 
       The Wanderer

Warning: Simply because I argue an issue does not mean I agree with any
side of it.

Secrecy is the beginning of tyranny.