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

[The Wanderer]

Diego Biurrun wrote:

> On Fri, Jul 18, 2008 at 12:43:04AM +0200, Stefano Sabatini wrote:

>> + * @param[in] val The value to set. If the field is not of a string
>> + * type, then the given string is parsed.
>> + * SI postfixes and some named scalars are supported.
>> + * If the field is of a numeric type, it has to be a numeric or named
>> + * scalar, behavior with more than one scalar and +- infix operators
>> + * is undefined.
> 
> If in doubt, use a period instead of a comma.

Here (for the second comma in the final sentence), a semicolon would
work just as well.

>> + * If the field is of a flags type, it has to be a sequence of numeric
>> + * scalars or named flags separated by '+' or '-'. Prefixing a flag
>> + * with '+' causes it to be set without affecting the other flags,
>> + * similarly '-' unsets a flag.
> 
> Similarly?

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.

-- 
       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.