# HG changeset patch
# User stefano
# Date 1215332210 0
# Node ID 68528efbc91f4b6efd36dd0f6aaf8f2d0c130a7c
# Parent  83ffe1bed06e8ce978849a95ed9ee30110950c16
Document av_find_opt().

diff -r 83ffe1bed06e -r 68528efbc91f opt.h
--- a/opt.h	Sun Jul 06 07:33:09 2008 +0000
+++ b/opt.h	Sun Jul 06 08:16:50 2008 +0000
@@ -85,6 +85,18 @@
 } AVOption;
 
 
+/**
+ * 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 it is the case that opt->flags & mask == flags).
+ *
+ * @param[in] obj a pointer to a struct whose first element is a
+ * pointer to an #AVClass
+ * @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
+ */
 const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags);
 const AVOption *av_set_string(void *obj, const char *name, const char *val);
 const AVOption *av_set_double(void *obj, const char *name, double n);