avfilter/internal: Doxygen for ff_fmt_is_in
authorGanesh Ajjanagadde <gajjanagadde@gmail.com>
Thu, 15 Oct 2015 02:56:54 +0000 (22:56 -0400)
committerGanesh Ajjanagadde <gajjanagadde@gmail.com>
Sat, 17 Oct 2015 22:58:38 +0000 (18:58 -0400)
This clarifies and adds Doxygen for ff_fmt_is_in.

Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
libavfilter/internal.h

index d92e120..1cc6bf3 100644 (file)
@@ -152,7 +152,15 @@ struct AVFilterInternal {
     avfilter_execute_func *execute;
 };
 
-/** Tell is a format is contained in the provided list terminated by -1. */
+/**
+ * Tell if an integer is contained in the provided -1-terminated list of integers.
+ * This is useful for determining (for instance) if an AVPixelFormat is in an
+ * array of supported formats.
+ *
+ * @param fmt provided format
+ * @param fmts -1-terminated list of formats
+ * @return 1 if present, 0 if absent
+ */
 int ff_fmt_is_in(int fmt, const int *fmts);
 
 /* Functions to parse audio format arguments */