[vlc-commits] include: layer the plugin API documentation

Rémi Denis-Courmont git at videolan.org
Sun Feb 11 20:56:05 CET 2018 

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Feb 11 21:55:42 2018 +0200| [417ed9eb80ad5ff08f0d316ea2b36f9d2dade6fc] | committer: Rémi Denis-Courmont

include: layer the plugin API documentation

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

 include/vlc_codec.h              | 11 +++++------
 include/vlc_common.h             |  9 ++++++---
 include/vlc_fs.h                 |  4 ++--
 include/vlc_input.h              |  1 +
 include/vlc_interface.h          |  1 +
 include/vlc_interrupt.h          |  8 +++-----
 include/vlc_keystore.h           |  1 +
 include/vlc_messages.h           |  1 +
 include/vlc_objects.h            |  1 +
 include/vlc_playlist.h           |  1 +
 include/vlc_renderer_discovery.h |  1 +
 include/vlc_strings.h            |  1 +
 include/vlc_vlm.h                |  1 +
 include/vlc_vout.h               |  1 +
 modules/access/http/connmgr.h    |  1 +
 15 files changed, 27 insertions(+), 16 deletions(-)

diff --git a/include/vlc_codec.h b/include/vlc_codec.h
index e8fd1f1574..a4842a5f3e 100644
--- a/include/vlc_codec.h
+++ b/include/vlc_codec.h
@@ -32,15 +32,13 @@
 #include <vlc_subpicture.h>
 
 /**
- * \defgroup codec Codec
- * Decoders and encoders
- * @{
- * \file
- * Decoder and encoder modules interface
- *
  * \defgroup decoder Decoder
+ * \ingroup input
  * Audio, video and text decoders
  * @{
+ *
+ * \file
+ * Decoder and encoder modules interface
  */
 
 typedef struct decoder_owner_sys_t decoder_owner_sys_t;
@@ -204,6 +202,7 @@ struct decoder_cc_desc_t
 
 /**
  * \defgroup encoder Encoder
+ * \ingroup sout
  * Audio, video and text encoders
  * @{
  */
diff --git a/include/vlc_common.h b/include/vlc_common.h
index 00b0e2fffa..5e8b979e3b 100644
--- a/include/vlc_common.h
+++ b/include/vlc_common.h
@@ -24,14 +24,16 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#ifndef VLC_COMMON_H
+# define VLC_COMMON_H 1
+
 /**
+ * \defgroup vlc VLC plug-in programming interface
  * \file
+ * \ingroup vlc
  * This file is a collection of common definitions and types
  */
 
-#ifndef VLC_COMMON_H
-# define VLC_COMMON_H 1
-
 /*****************************************************************************
  * Required vlc headers
  *****************************************************************************/
@@ -54,6 +56,7 @@
 
 /**
  * \defgroup cext C programming language extensions
+ * \ingroup vlc
  *
  * This section defines a number of macros and inline functions extending the
  * C language. Most extensions are implemented by GCC and LLVM/Clang, and have
diff --git a/include/vlc_fs.h b/include/vlc_fs.h
index 8fda513dfe..f3f50ea431 100644
--- a/include/vlc_fs.h
+++ b/include/vlc_fs.h
@@ -48,8 +48,9 @@ struct iovec;
 
 /**
  * \defgroup os Operating system
- * @{
+ * \ingroup vlc
  * \defgroup file File system
+ * \ingroup os
  * @{
  *
  * \file
@@ -251,7 +252,6 @@ VLC_API int vlc_mkdir(const char *dirname, mode_t mode);
 VLC_API char *vlc_getcwd(void) VLC_USED;
 
 /** @} */
-/** @} */
 
 #if defined( _WIN32 )
 typedef struct vlc_DIR
diff --git a/include/vlc_input.h b/include/vlc_input.h
index c23bb1e16e..f1298bf143 100644
--- a/include/vlc_input.h
+++ b/include/vlc_input.h
@@ -27,6 +27,7 @@
 
 /**
  * \defgroup input Input
+ * \ingroup vlc
  * Input thread
  * @{
  * \file
diff --git a/include/vlc_interface.h b/include/vlc_interface.h
index fd3a48a7ec..85b9d81534 100644
--- a/include/vlc_interface.h
+++ b/include/vlc_interface.h
@@ -34,6 +34,7 @@ typedef struct intf_dialog_args_t intf_dialog_args_t;
 
 /**
  * \defgroup interface Interface
+ * \ingroup vlc
  * VLC user interfaces
  * @{
  * \file
diff --git a/include/vlc_interrupt.h b/include/vlc_interrupt.h
index b98bbe24bb..a6fb303200 100644
--- a/include/vlc_interrupt.h
+++ b/include/vlc_interrupt.h
@@ -18,11 +18,6 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-/**
- * @file
- * This file declares interruptible sleep functions.
- */
-
 #ifndef VLC_INTERRUPT_H
 # define VLC_INTERRUPT_H 1
 # include <vlc_threads.h>
@@ -39,7 +34,10 @@ struct msghdr;
 
 /**
  * @defgroup interrupt Interruptible sleep
+ * @ingroup thread
  * @{
+ * @file
+ * This file declares interruptible sleep functions.
  * @defgroup interrupt_sleep Interruptible sleep functions
  * @{
  */
diff --git a/include/vlc_keystore.h b/include/vlc_keystore.h
index 5438d28efb..8fe8964b0b 100644
--- a/include/vlc_keystore.h
+++ b/include/vlc_keystore.h
@@ -37,6 +37,7 @@ libvlc_InternalKeystoreClean(libvlc_int_t *p_libvlc);
 
 /**
  * @defgroup keystore Keystore and credential API
+ * @ingroup os
  * @{
  * @file
  * This file declares vlc keystore API
diff --git a/include/vlc_messages.h b/include/vlc_messages.h
index 63f9476cd5..d14bbb8c3f 100644
--- a/include/vlc_messages.h
+++ b/include/vlc_messages.h
@@ -31,6 +31,7 @@
 
 /**
  * \defgroup messages Logging
+ * \ingroup os
  * \brief Message logs
  *
  * Functions for modules to emit log messages.
diff --git a/include/vlc_objects.h b/include/vlc_objects.h
index 11b7844b08..4e0314acbb 100644
--- a/include/vlc_objects.h
+++ b/include/vlc_objects.h
@@ -23,6 +23,7 @@
 
 /**
  * \defgroup vlc_object VLC objects
+ * \ingroup vlc
  * @{
  * \file
  * Common VLC object defintions
diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h
index c53fd33f2e..7884aa7bbd 100644
--- a/include/vlc_playlist.h
+++ b/include/vlc_playlist.h
@@ -37,6 +37,7 @@ struct intf_thread_t;
 
 /**
  * \defgroup playlist VLC playlist
+ * \ingroup interface
  * VLC playlist controls
  * @{
  * \file
diff --git a/include/vlc_renderer_discovery.h b/include/vlc_renderer_discovery.h
index ce383bbd57..fcb0cd7d2d 100644
--- a/include/vlc_renderer_discovery.h
+++ b/include/vlc_renderer_discovery.h
@@ -27,6 +27,7 @@
 
 /**
  * @defgroup vlc_renderer VLC renderer discovery
+ * @ingroup interface
  * @{
  *
  * @file
diff --git a/include/vlc_strings.h b/include/vlc_strings.h
index 9828fbd728..af5df4f6d6 100644
--- a/include/vlc_strings.h
+++ b/include/vlc_strings.h
@@ -26,6 +26,7 @@
 
 /**
  * \defgroup strings String helpers
+ * \ingroup cext
  * @{
  * \file
  * Helper functions for nul-terminated strings
diff --git a/include/vlc_vlm.h b/include/vlc_vlm.h
index 88d4437cc1..c5fddf0adc 100644
--- a/include/vlc_vlm.h
+++ b/include/vlc_vlm.h
@@ -29,6 +29,7 @@
 
 /**
  * \defgroup server VLM
+ * \ingroup interface
  * VLC stream manager
  *
  * VLM is the server core in vlc that allows streaming of multiple media streams
diff --git a/include/vlc_vout.h b/include/vlc_vout.h
index ce956390ca..60c148d498 100644
--- a/include/vlc_vout.h
+++ b/include/vlc_vout.h
@@ -32,6 +32,7 @@
 
 /**
  * \defgroup output Output
+ * \ingroup vlc
  * \defgroup video_output Video output
  * \ingroup output
  * Video rendering, output and window management
diff --git a/modules/access/http/connmgr.h b/modules/access/http/connmgr.h
index 41b9cd10ca..a4c258842d 100644
--- a/modules/access/http/connmgr.h
+++ b/modules/access/http/connmgr.h
@@ -20,6 +20,7 @@
 
 /**
  * \defgroup http HTTP
+ * \ingroup net
  * Hyper-Text Transfer Protocol
  * \defgroup http_connmgr Connection manager
  * HTTP connection management

More information about the vlc-commits mailing list