On Tue, Jun 14, 2011 at 12:57:53PM +0200, Anton Khirnov wrote:
> 
> --- a/libavutil/log.h
> +++ b/libavutil/log.h
> @@ -70,6 +70,13 @@ typedef struct {
>       * can be NULL of course
>       */
>      int parent_log_context_offset;
> +
> +    /**
> +     * A function for extended searching. E.g. scanning possible
> +     * children objects.

searching, e.g.

> --- a/libavutil/opt.h
> +++ b/libavutil/opt.h
> @@ -204,4 +209,30 @@ int av_opt_flag_is_set(void *obj, const char 
> *field_name, const char *flag_name)
> +
> +/**
> + * Look for an option in obj. Look only for the options which
> + * have the specified flags set.

Does the function look for one or multiple options?  And where does it
look?  "obj" has not yet been imbued with meaning...

> + * @param[in] obj A pointer to a struct whose first element is a
> + * pointer to an AVClass.

Indentation would make this more readable.

> + * @param[in] name The name of the option to look for.
> + * @param[in] unit When searching for named constants, name of the unit
> + *                 it belongs to.
> + * @param opt_flags Find only options with those flags set (AV_OPT_FLAG).

s/those/the specified/

It

> + * @param search_flags A combination of AV_OPT_SEARCH_*.

OK, but why would I want to provide these flags?

> + * @return A pointer to the option found, or NULL if no option
> + *         has been found.

was found

> + * @note Options found with AV_OPT_SEARCH_CHILDREN flag may not be

with the

> + * settable directly with av_set_string3. Use special calls which

IIRC you have to add () after the function name for Doxygen to pick it
up as something that should be linked.

> + * take an options AVDictionary (e.g. avformat_open_input() ) to set options

extra space before ')', long line

Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to