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

[Ganesh Ajjanagadde]

On Thu, Oct 15, 2015 at 6:26 AM, Ganesh Ajjanagadde
<gajjanagadde at gmail.com> wrote:
> On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu <timothygu99 at gmail.com> wrote:
>> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde <gajjanagadde at gmail.com>
>> wrote:
>>> This clarifies and Doxygen's the comment for ff_fmt_is_in.
>>
>>                      ^
>> gajjanag.c:1:23: error: unexpected token ‘adjective’
>
> sorry, missing something - does "This clarifies and adds Doxygen for
> ff_fmt_is_in" fix it?

Timothy: can you check this? Alternatively, can you tell me what tool
you used so that I can check locally?

>
>>
>>>
>>>
>>> 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.
>>
>>
>> -1-terminated
>>
>> Also what's the format supposed to be? If it can be used for all integers
>> (as the source seems to indicate) then say "tell if an integer is contained
>> … list of integers. This is useful for determining if BLAH format is in an
>> array of supported formats."
>
> Yes, the source is weird. If it is a pixel format, shouldn't the type
> signature have an enum instead of an int? At the moment though, you
> are completely right - will update and send new patch. Thanks.
>
>>
>>>
>>> + *
>>> + * @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);
>>
>>
>> Timothy