1 Jul 2008 01:14
Re: [PATCH] Document opt.h:av_find_opt()
The Wanderer <inverseparadox <at> comcast.net>
2008-06-30 23:14:24 GMT
2008-06-30 23:14:24 GMT
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(Continue reading). 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. > + * <at> param[in] obj a pointer to an #AVClass struct or to an #AVClass > + * context struct > + * <at> param[in] name the name of the option to look for > + * <at> param[in[ unit the unit of the option to look for or any if NULL > + * <at> 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.
.
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.
> + * <at> param[in] obj a pointer to an #AVClass struct or to an #AVClass
> + * context struct
> + * <at> param[in] name the name of the option to look for
> + * <at> param[in[ unit the unit of the option to look for or any if NULL
> + * <at> 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.
RSS Feed