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

[Alexander Strasser]

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>
---

Diff to v1:
  * use @p as suggested by ePirat
  * clarify that the hint about demuxer names is about FFmpeg

 libavutil/avstring.h | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/libavutil/avstring.h b/libavutil/avstring.h
index fc095349d2..1a5405581a 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 @p name, is found at least
+ * once in @p list.
+ *
+ * In both parameters, multiple names must be separated by the character
+ * given in @p separator.
+ *
+ * This is in line e.g. with the rule used for naming demuxers in FFmpeg.
+ *
+ * @param name      Contains names searched for in list.
+ * @param list      List of names that is searched in.
+ * @param separator Character that separates items in the given lists.
+ *
+ * @returns 0 if no match was found, otherwise 1.
  */
 int av_match_list(const char *name, const char *list, char separator);

--