summaryrefslogtreecommitdiff
path: root/libavutil/avstring.h
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2011-11-20 20:38:24 +0100
committerLuca Barbato <lu_zero@gentoo.org>2011-11-22 17:16:02 +0100
commit757cd8d876b18c07e00b53fd4e5c01bedc106d2e (patch)
treeeab216085c5b151ac19d37f0f57df76f9d60031d /libavutil/avstring.h
parent384bdaceeb9c82d5b64a6f73e5273298b38028e9 (diff)
doxy: provide a start page and document libavutil
Introduce a basic layout, the subpages are currently left empty. Split libavutil in multiple groups as example of the structure
Diffstat (limited to 'libavutil/avstring.h')
-rw-r--r--libavutil/avstring.h21
1 files changed, 15 insertions, 6 deletions
diff --git a/libavutil/avstring.h b/libavutil/avstring.h
index 6988f0e3e8..35b3d46c03 100644
--- a/libavutil/avstring.h
+++ b/libavutil/avstring.h
@@ -25,6 +25,11 @@
#include "attributes.h"
/**
+ * @addtogroup lavu_string
+ * @{
+ */
+
+/**
* Return non-zero if pfx is a prefix of str. If it is, *ptr is set to
* the address of the first character in str after the prefix.
*
@@ -72,7 +77,7 @@ char *av_stristr(const char *haystack, const char *needle);
* @param size size of destination buffer
* @return the length of src
*
- * WARNING: since the return value is the length of src, src absolutely
+ * @warning since the return value is the length of src, src absolutely
* _must_ be a properly 0-terminated string, otherwise this will read beyond
* the end of the buffer and possibly crash.
*/
@@ -90,9 +95,9 @@ size_t av_strlcpy(char *dst, const char *src, size_t size);
* @param size size of destination buffer
* @return the total length of src and dst
*
- * WARNING: since the return value use the length of src and dst, these absolutely
- * _must_ be a properly 0-terminated strings, otherwise this will read beyond
- * the end of the buffer and possibly crash.
+ * @warning since the return value use the length of src and dst, these
+ * absolutely _must_ be a properly 0-terminated strings, otherwise this
+ * will read beyond the end of the buffer and possibly crash.
*/
size_t av_strlcat(char *dst, const char *src, size_t size);
@@ -153,14 +158,18 @@ static inline int av_tolower(int c)
/*
* Locale independent case-insensitive compare.
- * Note: This means only ASCII-range characters are case-insensitive
+ * @note This means only ASCII-range characters are case-insensitive
*/
int av_strcasecmp(const char *a, const char *b);
/**
* Locale independent case-insensitive compare.
- * Note: This means only ASCII-range characters are case-insensitive
+ * @note This means only ASCII-range characters are case-insensitive
*/
int av_strncasecmp(const char *a, const char *b, size_t n);
+/**
+ * @}
+ */
+
#endif /* AVUTIL_AVSTRING_H */