[FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
This clarifies and Doxygen's the comment for ff_fmt_is_in.
Signed-off-by: Ganesh Ajjanagadde
---
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
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde
wrote:
> This clarifies and Doxygen's the comment for ff_fmt_is_in.
^
gajjanag.c:1:23: error: unexpected token ‘adjective’
>
> Signed-off-by: Ganesh Ajjanagadde
> ---
> 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."
> + *
> + * @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
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu wrote:
> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde
> 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?
>
>>
>>
>> Signed-off-by: Ganesh Ajjanagadde
>> ---
>> 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
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Thu, Oct 15, 2015 at 6:26 AM, Ganesh Ajjanagadde
wrote:
> On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu wrote:
>> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde
>> 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
>>> ---
>>> 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
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Sat, Oct 17, 2015 at 7:59 AM Ganesh Ajjanagadde wrote: > On Thu, Oct 15, 2015 at 6:26 AM, Ganesh Ajjanagadde > wrote: > > On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu > wrote: > >> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde < > gajjanaga...@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? > Yes. > Alternatively, can you tell me what tool > you used so that I can check locally? > I'm pretty sure you already have the tool I used. It's something *very* local to you, especially to the part of you that is reading this sentence ;) Timothy ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Sat, Oct 17, 2015 at 6:34 PM, Timothy Gu wrote: > On Sat, Oct 17, 2015 at 7:59 AM Ganesh Ajjanagadde > wrote: >> >> On Thu, Oct 15, 2015 at 6:26 AM, Ganesh Ajjanagadde >> wrote: >> > On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu >> > wrote: >> >> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde >> >> >> >> 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? > > > Yes. > >> >> Alternatively, can you tell me what tool >> you used so that I can check locally? > > > I'm pretty sure you already have the tool I used. It's something *very* > local to you, especially to the part of you that is reading this sentence ;) Ah, just a English language check - I thought of something else due to the caret underneath the word, etc. I will update and push later sometime. Thanks. > > Timothy ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
Re: [FFmpeg-devel] [PATCH 1/2] avfilter/internal: Doxygen for ff_fmt_is_in
On Sat, Oct 17, 2015 at 6:44 PM, Ganesh Ajjanagadde wrote: > On Sat, Oct 17, 2015 at 6:34 PM, Timothy Gu wrote: >> On Sat, Oct 17, 2015 at 7:59 AM Ganesh Ajjanagadde >> wrote: >>> >>> On Thu, Oct 15, 2015 at 6:26 AM, Ganesh Ajjanagadde >>> wrote: >>> > On Thu, Oct 15, 2015 at 1:45 AM, Timothy Gu >>> > wrote: >>> >> On Wed, Oct 14, 2015 at 8:05 PM Ganesh Ajjanagadde >>> >> >>> >> 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? >> >> >> Yes. >> >>> >>> Alternatively, can you tell me what tool >>> you used so that I can check locally? >> >> >> I'm pretty sure you already have the tool I used. It's something *very* >> local to you, especially to the part of you that is reading this sentence ;) > > Ah, just a English language check - I thought of something else due to > the caret underneath the word, etc. I will update and push later > sometime. Thanks. pushed > >> >> Timothy ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org http://ffmpeg.org/mailman/listinfo/ffmpeg-devel
