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

[Diego Biurrun]

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.

> + * @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.

Diego