[FFmpeg-devel] [PATCH] Document opt.h:av_find_opt()

[The Wanderer]

Stefano Sabatini wrote:

> Hi all,
> continues the opt.h documentation saga.
> 
> I took account in this patch to all the previous remarks done by
> Diego, Michael, The Wanderer as much as my mind made it possible ;-).

Not bad, but I see a couple of possible improvements. (This is almost on 
the level of nitpicking, but I points 'em out as I sees 'em...)

> + * Looks for an option in \p obj. Looks only for the options which
> + * have the flags set as specified in \p mask and \p flags (that is,
> + * for which is: opt->flags & mask == flags).

I would probably say something more like "for which it is the case that"
(or, less precisely but more simply, just "for which") and drop the
colon.

> + * @param[in] obj a pointer to an #AVClass struct or to an #AVClass
> + * context struct
> + * @param[in] name the name of the option to look for
> + * @param[in[ unit the unit of the option to look for or any if NULL
> + * @return a pointer to the option found or NULL if no option
> + * has been found

I would add a comma before the "or" on both of these last two.

Other than that, looks fairly good to me.

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