[FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in

Ganesh Ajjanagadde gajjanagadde at gmail.com
Thu Oct 15 05:02:32 CEST 2015


This clarifies and Doxygen's the comment for ff_fmt_is_in.

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde at gmail.com>
---
 libavfilter/internal.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/libavfilter/internal.h b/libavfilter/internal.h
index bb94707..c07d306 100644
--- a/libavfilter/internal.h
+++ b/libavfilter/internal.h
@@ -152,7 +152,13 @@ struct AVFilterInternal {
     avfilter_execute_func *execute;
 };
 
-/** Tell is a format is contained in the provided list terminated by -1. */
+/**
+ * Tell if a format is contained in the provided -1 terminated list of 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 */
-- 
2.6.1



More information about the ffmpeg-devel mailing list