avfilter/internal: Doxygen for ff_fmt_is_in

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>

diff --git a/libavfilter/internal.h b/libavfilter/internal.h
index d92e1204f5d50d189e96e7f50a49c051754db927..1cc6bf3b10dfa46b8be9b2473466c71f2debbb7f 100644 (file)
--- a/libavfilter/internal.h
+++ b/libavfilter/internal.h
@@ -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 */