[FFmpeg-devel] [PATCH] libavutil/avstring: av_match_list: Update API documentation

[Alexander Strasser]

On 2025-01-22 23:19 +0100, epirat07 at gmail.com wrote:
>
> On 22 Jan 2025, at 22:59, Alexander Strasser via ffmpeg-devel wrote:
>
> > Since av_match_list was added in commit 0d92b0d5f445d4f2 , this
> > function changed its semantics shortly after, especially with
> > commit 3c0b98dced394da3 .
> >
> > Signed-off-by: Alexander Strasser <eclipse7 at gmx.net>
> > ---
> >  libavutil/avstring.h | 18 +++++++++++++++---
> >  1 file changed, 15 insertions(+), 3 deletions(-)
> >
> > diff --git a/libavutil/avstring.h b/libavutil/avstring.h
> > index fc095349d2..133d021632 100644
> > --- a/libavutil/avstring.h
> > +++ b/libavutil/avstring.h
> > @@ -409,9 +409,21 @@ int av_utf8_decode(int32_t *codep, const uint8_t **bufp, const uint8_t *buf_end,
> >                     unsigned int flags);
> >
> >  /**
> > - * Check if a name is in a list.
> > - * @returns 0 if not found, or the 1 based index where it has been found in the
> > - *            list.
> > + * Check if one of the given names is in a list.
> > + *
> > + * Check if any of the names, given in parameter name, is found at least
>
> You can use @p to refer to parameters, like: "given in @p name".

Good idea! Sent v2.

[...]

Thanks
  Alexander