Commit 417ed9eb authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

include: layer the plugin API documentation

parent 2d5d6569
......@@ -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
* @{
*/
......
......@@ -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
......
......@@ -48,8 +48,9 @@ struct iovec;
/**
* \defgroup os Operating system
* @{
* \ingroup vlc
* \defgroup file File system
* \ingroup os
* @{
*
* \file
......@@ -250,7 +251,6 @@ VLC_API int vlc_mkdir(const char *dirname, mode_t mode);
*/
VLC_API char *vlc_getcwd(void) VLC_USED;
/** @} */
/** @} */
#if defined( _WIN32 )
......
......@@ -27,6 +27,7 @@
/**
* \defgroup input Input
* \ingroup vlc
* Input thread
* @{
* \file
......
......@@ -34,6 +34,7 @@ typedef struct intf_dialog_args_t intf_dialog_args_t;
/**
* \defgroup interface Interface
* \ingroup vlc
* VLC user interfaces
* @{
* \file
......
......@@ -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
* @{
*/
......
......@@ -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
......
......@@ -31,6 +31,7 @@
/**
* \defgroup messages Logging
* \ingroup os
* \brief Message logs
*
* Functions for modules to emit log messages.
......
......@@ -23,6 +23,7 @@
/**
* \defgroup vlc_object VLC objects
* \ingroup vlc
* @{
* \file
* Common VLC object defintions
......
......@@ -37,6 +37,7 @@ struct intf_thread_t;
/**
* \defgroup playlist VLC playlist
* \ingroup interface
* VLC playlist controls
* @{
* \file
......
......@@ -27,6 +27,7 @@
/**
* @defgroup vlc_renderer VLC renderer discovery
* @ingroup interface
* @{
*
* @file
......
......@@ -26,6 +26,7 @@
/**
* \defgroup strings String helpers
* \ingroup cext
* @{
* \file
* Helper functions for nul-terminated strings
......
......@@ -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
......
......@@ -32,6 +32,7 @@
/**
* \defgroup output Output
* \ingroup vlc
* \defgroup video_output Video output
* \ingroup output
* Video rendering, output and window management
......
......@@ -20,6 +20,7 @@
/**
* \defgroup http HTTP
* \ingroup net
* Hyper-Text Transfer Protocol
* \defgroup http_connmgr Connection manager
* HTTP connection management
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment