util/StringCompare: add API documentation

MusicPlayerDaemon · Oct 15, 2020 · 41f6d44 · 41f6d44
1 parent fc505f4
commit 41f6d44
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/util/StringCompare.hxx b/src/util/StringCompare.hxx
@@ -107,6 +107,12 @@ StringStartsWithIgnoreCase(StringView haystack, StringView needle) noexcept
 		StringIsEqualIgnoreCase(haystack.data, needle.data, needle.size);
 }
 
+/**
+ * Returns the portion of the string after a prefix.  If the string
+ * does not begin with the specified prefix, this function returns
+ * nullptr.
+ * This function is case-independent.
+ */
 gcc_pure gcc_nonnull_all
 static inline const char *
 StringAfterPrefixIgnoreCase(const char *haystack, StringView needle) noexcept