Browse code

More descriptive names for av_stristr() parameters

Originally committed as revision 22349 to svn://svn.ffmpeg.org/ffmpeg/trunk

Måns Rullgård authored on 2010/03/09 07:16:05
Showing 1 changed files
... ...
@@ -47,17 +47,18 @@ int av_strstart(const char *str, const char *pfx, const char **ptr);
47 47
 int av_stristart(const char *str, const char *pfx, const char **ptr);
48 48
 
49 49
 /**
50
- * Locate the first case-independent occurrence in the string s1 of
51
- * the string s2.  A zero-length string s2 is considered to match at
52
- * the start of s1.
50
+ * Locate the first case-independent occurrence in the string haystack
51
+ * of the string needle.  A zero-length string needle is considered to
52
+ * match at the start of haystack.
53 53
  *
54 54
  * This function is a case-insensitive version of the standard strstr().
55 55
  *
56
- * @param s1 string to search in
57
- * @param s2 string to search for
58
- * @return pointer to the located match within s1 or a null pointer if no match
56
+ * @param haystack string to search in
57
+ * @param needle   string to search for
58
+ * @return         pointer to the located match within haystack
59
+ *                 or a null pointer if no match
59 60
  */
60
-char *av_stristr(const char *s1, const char *s2);
61
+char *av_stristr(const char *haystack, const char *needle);
61 62
 
62 63
 /**
63 64
  * Copy the string src to dst, but no more than size - 1 bytes, and