From 62144b225d077b201a723d843d38c6d15cb087f9 Mon Sep 17 00:00:00 2001 From: Ganesh Ajjanagadde Date: Wed, 14 Oct 2015 22:56:54 -0400 Subject: [PATCH] avfilter/internal: Doxygen for ff_fmt_is_in This clarifies and adds Doxygen for ff_fmt_is_in. Reviewed-by: Timothy Gu Signed-off-by: Ganesh Ajjanagadde --- libavfilter/internal.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/libavfilter/internal.h b/libavfilter/internal.h index d92e1204f5..1cc6bf3b10 100644 --- 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 */ -- 2.11.0