[vlc-commits] Improve Doxygen

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Apr 11 23:11:20 2020 +0300| [dff02aaf28a71885787a98d2d55b0cb33d93f3ea] | committer: Rémi Denis-Courmont

Improve Doxygen

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=dff02aaf28a71885787a98d2d55b0cb33d93f3ea
---

 include/vlc_charset.h | 24 ++++++++++++++++++------
 include/vlc_url.h     |  6 +++---
 2 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/include/vlc_charset.h b/include/vlc_charset.h
index 511236275f..0ec1734dc9 100644
--- a/include/vlc_charset.h
+++ b/include/vlc_charset.h
@@ -25,9 +25,9 @@
 #define VLC_CHARSET_H 1
 
 /**
- * \file
- * Characters sets handling
- *
+ * \file vlc_charset.h
+ * \ingroup charset
+ * \defgroup charset Character sets
  * \ingroup strings
  * @{
  */
@@ -128,13 +128,21 @@ static inline char *EnsureUTF8(char *str)
     return ret;
 }
 
-/* iconv wrappers (defined in src/extras/libc.c) */
+/**
+ * \defgroup iconv iconv wrappers
+ *
+ * (defined in src/extras/libc.c)
+ * @{
+ */
+
 #define VLC_ICONV_ERR ((size_t) -1)
 typedef void *vlc_iconv_t;
 VLC_API vlc_iconv_t vlc_iconv_open( const char *, const char * ) VLC_USED;
 VLC_API size_t vlc_iconv( vlc_iconv_t, const char **, size_t *, char **, size_t * ) VLC_USED;
 VLC_API int vlc_iconv_close( vlc_iconv_t );
 
+/** @} */
+
 #include <stdarg.h>
 
 VLC_API int utf8_vfprintf( FILE *stream, const char *fmt, va_list ap );
@@ -337,12 +345,16 @@ static inline char *FromLatin1 (const char *latin)
     return utf8 ? utf8 : str;
 }
 
-/** @} */
-
+/**
+ * \defgroup c_locale C/POSIX locale functions
+ * @{
+ */
 VLC_API double us_strtod( const char *, char ** ) VLC_USED;
 VLC_API float us_strtof( const char *, char ** ) VLC_USED;
 VLC_API double us_atof( const char * ) VLC_USED;
 VLC_API int us_vasprintf( char **, const char *, va_list );
 VLC_API int us_asprintf( char **, const char *, ... ) VLC_USED;
+/** @} */
+/** @} */
 
 #endif
diff --git a/include/vlc_url.h b/include/vlc_url.h
index f67b32a072..68a663fb03 100644
--- a/include/vlc_url.h
+++ b/include/vlc_url.h
@@ -25,9 +25,9 @@
 # define VLC_URL_H
 
 /**
- * \file
- * This file defines functions for manipulating URL in vlc
- *
+ * \file vlc_url.h
+ * \ingroup url
+ * \defgroup url Uniform Resource Locator (URL)
  * \ingroup strings
  * @{
  */