Add a bunch of \file doxygen comments
authorJean-Paul Saman <jpsaman@videolan.org>
Mon, 11 Aug 2008 15:31:57 +0000 (23:31 +0800)
committerJean-Paul Saman <jpsaman@videolan.org>
Wed, 13 Aug 2008 14:22:58 +0000 (22:22 +0800)
43 files changed:
include/vlc_access.h
include/vlc_aout.h
include/vlc_arrays.h
include/vlc_bits.h
include/vlc_block.h
include/vlc_charset.h
include/vlc_codecs.h
include/vlc_config.h
include/vlc_configuration.h
include/vlc_demux.h
include/vlc_devices.h
include/vlc_epg.h
include/vlc_es_out.h
include/vlc_gcrypt.h
include/vlc_httpd.h
include/vlc_image.h
include/vlc_input.h
include/vlc_intf_strings.h
include/vlc_iso_lang.h
include/vlc_keys.h
include/vlc_main.h
include/vlc_md5.h
include/vlc_messages.h
include/vlc_meta.h
include/vlc_modules.h
include/vlc_network.h
include/vlc_osd.h
include/vlc_plugin.h
include/vlc_rand.h
include/vlc_services_discovery.h
include/vlc_sout.h
include/vlc_stream.h
include/vlc_strings.h
include/vlc_threads.h
include/vlc_tls.h
include/vlc_update.h
include/vlc_url.h
include/vlc_variables.h
include/vlc_vlm.h
include/vlc_vod.h
include/vlc_vout.h
include/vlc_window.h
include/vlc_xml.h

index a3c5be9..9ddc64a 100644 (file)
 #ifndef VLC_ACCESS_H
 #define VLC_ACCESS_H 1
 
+/**
+ * \file
+ * This file defines functions and definitions for access object
+ */
+
 #include <vlc_block.h>
 
 /**
index 7d11984..993fa01 100644 (file)
 #ifndef VLC_AOUT_H
 #define VLC_AOUT_H 1
 
+/**
+ * \file
+ * This file defines functions, structures and macros for audio output object
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif
@@ -86,7 +91,6 @@ typedef int32_t vlc_fixed_t;
 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
 
-
 /*
  * Channels descriptions
  */
index a95bc23..faf69d4 100644 (file)
 #ifndef VLC_ARRAYS_H_
 #define VLC_ARRAYS_H_
 
+/**
+ * \file
+ * This file defines functions, structures and macros for handling arrays in vlc
+ */
+
 /**
  * Simple dynamic array handling. Array is realloced at each insert/removal
  */
index 9f3d7fd..4dcfa2f 100644 (file)
 #ifndef VLC_BITS_H
 #define VLC_BITS_H 1
 
+/**
+ * \file
+ * This file defines functions, structures for handling streams of bits in vlc
+ */
+
 typedef struct bs_s
 {
     uint8_t *p_start;
@@ -40,14 +45,17 @@ static inline void bs_init( bs_t *s, void *p_data, int i_data )
     s->p_end   = s->p + i_data;
     s->i_left  = 8;
 }
+
 static inline int bs_pos( bs_t *s )
 {
     return( 8 * ( s->p - s->p_start ) + 8 - s->i_left );
 }
+
 static inline int bs_eof( bs_t *s )
 {
     return( s->p >= s->p_end ? 1: 0 );
 }
+
 static inline uint32_t bs_read( bs_t *s, int i_count )
 {
      static const uint32_t i_mask[33] =
@@ -167,6 +175,7 @@ static inline void bs_align( bs_t *s )
         s->p++;
     }
 }
+
 static inline void bs_align_0( bs_t *s )
 {
     if( s->i_left != 8 )
@@ -174,6 +183,7 @@ static inline void bs_align_0( bs_t *s )
         bs_write( s, s->i_left, 0 );
     }
 }
+
 static inline void bs_align_1( bs_t *s )
 {
     while( s->i_left != 8 )
index cdd337a..b882b1f 100644 (file)
 #ifndef VLC_BLOCK_H
 #define VLC_BLOCK_H 1
 
+/**
+ * \file
+ * This file implements functions and structures to handle blocks of data in vlc
+ *
+ */
+
 /****************************************************************************
  * block:
  ****************************************************************************
index 3392bc1..76d9a03 100644 (file)
 #ifndef VLC_CHARSET_H
 #define VLC_CHARSET_H 1
 
+/**
+ * \file
+ * This files handles locale conversions in vlc
+ */
+
 #include <stdarg.h>
 #include <sys/types.h>
 #include <dirent.h>
index 988c590..4604711 100644 (file)
 #ifndef VLC_CODECS_H
 #define VLC_CODECS_H 1
 
+/**
+ * \file
+ * This file defines codec related structures needed by the demuxers and decoders
+ */
+
 #ifdef HAVE_ATTRIBUTE_PACKED
 #   define ATTR_PACKED __attribute__((__packed__))
 #else
index 316179a..4a51435 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines of values used in interface, vout, aout and vlc core functions.
+ */
+
 /* Conventions regarding names of symbols and variables
  * ----------------------------------------------------
  *
index 5e0911a..36d46cb 100644 (file)
 #ifndef VLC_CONFIGURATION_H
 #define VLC_CONFIGURATION_H 1
 
+/**
+ * \file
+ * This file describes the programming interface for the configuration module.
+ * It includes functions allowing to declare, get or set configuration options.
+ */
 
 # ifdef __cplusplus
 extern "C" {
index 5a0fc0b..2790950 100644 (file)
 #ifndef VLC_DEMUX_H
 #define VLC_DEMUX_H 1
 
+/**
+ * \file
+ * This files defines functions and structures used by demux objects in vlc
+ */
+
 #include <vlc_es.h>
 #include <vlc_stream.h>
 #include <vlc_es_out.h>
index 46b7412..ba0d5f8 100644 (file)
 #ifndef VLC_DEVICES_H
 #define VLC_DEVICES_H 1
 
+/**
+ * \file
+ * This file implements functions, structures for probing devices (DVD, CD, VCD)
+ */
+
 enum
 {
     DEVICE_CAN_DVD,
index 25a9431..f1ffabe 100644 (file)
 #ifndef VLC_EPG_H
 #define VLC_EPG_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for storing dvb epg information
+ */
+
 typedef struct
 {
     int64_t i_start;    /* Interpreted as a value return by time() */
@@ -50,6 +55,7 @@ static inline void vlc_epg_Init( vlc_epg_t *p_epg, const char *psz_name )
     p_epg->p_current = NULL;
     TAB_INIT( p_epg->i_event, p_epg->pp_event );
 }
+
 static inline void vlc_epg_Clean( vlc_epg_t *p_epg )
 {
     int i;
@@ -64,6 +70,7 @@ static inline void vlc_epg_Clean( vlc_epg_t *p_epg )
     TAB_CLEAN( p_epg->i_event, p_epg->pp_event );
     free( p_epg->psz_name );
 }
+
 static inline void vlc_epg_AddEvent( vlc_epg_t *p_epg, int64_t i_start, int i_duration,
                                 const char *psz_name, const char *psz_short_description, const char *psz_description )
 {
@@ -85,11 +92,13 @@ static inline vlc_epg_t *vlc_epg_New( const char *psz_name )
         vlc_epg_Init( p_epg, psz_name );
     return p_epg;
 }
+
 static inline void vlc_epg_Delete( vlc_epg_t *p_epg )
 {
     vlc_epg_Clean( p_epg );
     free( p_epg );
 }
+
 static inline void vlc_epg_SetCurrent( vlc_epg_t *p_epg, int64_t i_start )
 {
     int i;
index 782c1b3..bd65448 100644 (file)
 #ifndef VLC_ES_OUT_H
 #define VLC_ES_OUT_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for handling es_out in stream output
+ */
+
 /**
  * \defgroup es out Es Out
  * @{
@@ -105,10 +110,12 @@ static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
 {
     return out->pf_add( out, fmt );
 }
+
 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
 {
     out->pf_del( out, id );
 }
+
 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
                                block_t *p_block )
 {
@@ -119,6 +126,7 @@ static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
 {
     return out->pf_control( out, i_query, args );
 }
+
 static inline int es_out_Control( es_out_t *out, int i_query, ... )
 {
     va_list args;
index 3a2e631..8502910 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file implements gcrypt support functions in vlc
+ */
+
 #ifdef LIBVLC_USE_PTHREAD
 /**
  * If possible, use gcrypt-provided thread implementation. This is so that
@@ -26,6 +31,7 @@
 GCRY_THREAD_OPTION_PTHREAD_IMPL;
 # define gcry_threads_vlc gcry_threads_pthread
 #else
+
 /**
  * gcrypt thread option VLC implementation
  */
index 2bbf47d..5febb37 100644 (file)
 #ifndef VLC_HTTPD_H
 #define VLC_HTTPD_H 1
 
+/**
+ * \file
+ * This file defines functions, structures, enums and macros for httpd functionality in vlc.
+ */
+
 enum
 {
     HTTPD_MSG_NONE,
index cd7686a..a7ab94c 100644 (file)
 #ifndef VLC_IMAGE_H
 #define VLC_IMAGE_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for image conversions in vlc
+ */
+
 #include <vlc_vout.h>
 
 # ifdef __cplusplus
index 8663f11..09603e3 100644 (file)
 #ifndef VLC__INPUT_H
 #define VLC__INPUT_H 1
 
+/**
+ * \file
+ * This file defines functions, structures and enums for input objects in vlc
+ */
+
 #include <vlc_es.h>
 #include <vlc_meta.h>
 #include <vlc_epg.h>
index 050ffd3..c709a66 100644 (file)
 #ifndef VLC_INTF_STRINGS_H
 #define VLC_INTF_STRINGS_H 1
 
+/**
+ * \file
+ * This file defines a number of strings used in user interfaces
+ */
+
 /*************** Open dialogs **************/
 
 #define I_OP_OPF        N_("Quick &Open File...")
index 44823e4..2d8ddb6 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines functions and structures for iso639 language codes
+ */
+
 struct iso639_lang_t
 {
     const char * psz_eng_name;        /* Description in English */
index 87541d5..a3fca57 100644 (file)
 #ifndef VLC_KEYS_H
 #define VLC_KEYS_H 1
 
+/**
+ * \file
+ * This file defines keys, functions and structures for hotkey handling in vlc
+ *
+ */
+
 #define KEY_MODIFIER         0xFF000000
 #define KEY_MODIFIER_ALT     0x01000000
 #define KEY_MODIFIER_SHIFT   0x02000000
index 1d1810e..119b177 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines libvlc_int_t internal libvlc instance
+ */
+
 TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
 
 /*****************************************************************************
index 9acca98..d051269 100644 (file)
 #ifndef VLC_MD5_H
 # define VLC_MD5_H
 
+/**
+ * \file
+ * This file defines functions and structures for handling md5 checksums
+ */
+
 /*****************************************************************************
  * md5_s: MD5 message structure
  *****************************************************************************
index c411367..c0b8ee5 100644 (file)
 #ifndef VLC_MESSAGES_H_
 #define VLC_MESSAGES_H_
 
+/**
+ * \file
+ * This file defines structures and functions to handle messages and statistics gathering
+ */
+
 #include <stdarg.h>
 
 /**
index 19be412..a2abee0 100644 (file)
 #ifndef VLC_META_H
 #define VLC_META_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for stream meta-data in vlc
+ *
+ */
+
 #include <vlc_arrays.h>
 
 typedef enum vlc_meta_type_t
index 7d965bc..9702397 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines functions for modules in vlc
+ */
+
 /*****************************************************************************
  * Exported functions.
  *****************************************************************************/
index e2200d3..5c4b1dc 100644 (file)
 #ifndef VLC_NETWORK_H
 # define VLC_NETWORK_H
 
+/**
+ * \file
+ * This file defines interface to communicate with network plug-ins
+ */
+
 #if defined( WIN32 )
 #   if !defined(UNDER_CE)
 #       define _NO_OLDNAMES 1
index d9fa797..a332b61 100644 (file)
 extern "C" {
 # endif
 
+/**
+ * \file
+ * This file defines SPU subpicture and OSD functions and object types.
+ */
+
 /**********************************************************************
  * Base SPU structures
  **********************************************************************/
index f0d2554..cc51ddc 100644 (file)
 #ifndef LIBVLC_MODULES_MACROS_H
 # define LIBVLC_MODULES_MACROS_H 1
 
+/**
+ * \file
+ * This file implements plugin (module) macros used to define a vlc module.
+ */
+
 /*****************************************************************************
  * If we are not within a module, assume we're in the vlc core.
  *****************************************************************************/
index 2afff19..56e07af 100644 (file)
 #ifndef VLC_RAND_H
 # define VLC_RAND_H
 
+/**
+ * \file
+ * This file defined random number generator function in vlc
+ */
+
 VLC_EXPORT( void, vlc_rand_bytes, (void *buf, size_t len) );
 
 #endif
index 33e354b..7583421 100644 (file)
 #ifndef VLC_SERVICES_DISCOVERY_H_
 #define VLC_SERVICES_DISCOVERY_H_
 
+/**
+ * \file
+ * This file functions and structures for service discovery in vlc
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif
index 576e830..811146f 100644 (file)
 #ifndef VLC_SOUT_H_
 #define VLC_SOUT_H_
 
+/**
+ * \file
+ * This file defines structures and functions for stream ouput in vlc
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
index 13a0155..eba91cf 100644 (file)
 
 #include <vlc_block.h>
 
+/**
+ * \file
+ * This file defines structures and functions for stream (between access and demux) descriptor in vlc
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif
@@ -122,7 +127,6 @@ VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz
 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 
-
 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool i_preserve_memory ) );
 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
index 82d947a..eab608e 100644 (file)
 #ifndef VLC_STRINGS_H
 #define VLC_STRINGS_H 1
 
+/**
+ * \file
+ * This file defines functions and structures handling misc strings
+ */
+
 /**
  * \defgroup strings Strings
  * @{
index 5cee5bf..0acffce 100644 (file)
 #ifndef VLC_THREADS_H_
 #define VLC_THREADS_H_
 
+/**
+ * \file
+ * This file defines structures and functions for handling threads in vlc
+ *
+ */
+
 #if defined( UNDER_CE )
                                                                 /* WinCE API */
 #elif defined( WIN32 )
index 7bf3500..84d5953 100644 (file)
 #ifndef VLC_TLS_H
 # define VLC_TLS_H
 
+/**
+ * \file
+ * This file defines Transport Layer Security API (TLS) in vlc
+ */
+
 # include <vlc_network.h>
 
 typedef struct tls_server_sys_t tls_server_sys_t;
index d53d898..1bb91f9 100644 (file)
 #ifndef VLC_UPDATE_H
 #define VLC_UPDATE_H
 
+/**
+ * \file
+ * This file defines update API in vlc
+ */
+
 /**
  * \defgroup update Update
  *
@@ -46,7 +51,6 @@ struct update_release_t
     char* psz_desc;     ///< Release description
 };
 
-
 #endif /* UPDATE_CHECK */
 
 typedef struct update_release_t update_release_t;
index 4e95c7d..7cedd5b 100644 (file)
 #ifndef VLC_URL_H
 # define VLC_URL_H
 
+/**
+ * \file
+ * This file defines functions for manipulating URL in vlc
+ */
+
 struct vlc_url_t
 {
     char *psz_protocol;
@@ -192,7 +197,6 @@ static inline void vlc_UrlClean( vlc_url_t *url )
     url->psz_buffer   = NULL;
 }
 
-
 static inline char *vlc_UrlEncode( const char *psz_url )
 {
     /* FIXME: do not encode / : ? and & _when_ not needed */
@@ -227,5 +231,4 @@ static inline int vlc_UrlIsNotEncoded( const char *psz_url )
     return 0; /* looks fine - but maybe it is not encoded */
 }
 
-
 #endif
index 7c2bbd4..aa1c6b4 100644 (file)
 #ifndef VLC_VARIABLES_H
 #define VLC_VARIABLES_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for dynamic variables in vlc
+ */
+
 /**
  * \defgroup variables Variables
  *
index d85034f..665cf2d 100644 (file)
 #ifndef VLC_VLM_H
 #define VLC_VLM_H 1
 
+/**
+ * \file
+ * This file defines VLM core functions and structures in vlc
+ */
+
 #include <vlc_input.h>
 
+/**
+ * \defgroup server VLM
+ * VLM is the server core in vlc that allows streaming of multiple media streams
+ * at the same time. It provides broadcast, schedule and video on demand features
+ * for streaming using several streaming and network protocols.
+ * @{
+ */
+
 /* VLM media */
 typedef struct
 {
@@ -270,4 +283,6 @@ static inline void vlm_media_instance_Delete( vlm_media_instance_t *p_instance )
 }
 #endif
 
+/**@}*/
+
 #endif
index 52cdd30..17cd2e4 100644 (file)
 #ifndef VLC_VOD_H
 #define VLC_VOD_H 1
 
+/**
+ * \file
+ * This file defines an interface for VOD server modules in vlc
+ */
+
+/**
+ * \defgroup server Video On Demand (VOD)
+ * Video On Demand (VOD) functionality is provided from VLM.
+ * @{
+ */
+
 struct vod_t
 {
     VLC_COMMON_MEMBERS
@@ -67,4 +78,6 @@ enum vod_query_e
     VOD_MEDIA_FORWARD,      /* arg1= double         res=    */
 };
 
+/**}*/
+
 #endif
index f806888..47fc3fd 100644 (file)
 #ifndef VLC_VOUT_H_
 #define VLC_VOUT_H_ 1
 
+/**
+ * \file
+ * This file defines common video output structures and functions in vlc
+ */
+
 #include <vlc_es.h>
 #include <vlc_filter.h>
 
index 8cbb75a..9e95a6b 100644 (file)
 #ifndef LIBVLCCORE_WINDOW_H
 # define LIBVLCCORE_WINDOW_H 1
 
+/**
+ * \file
+ * This file defines functions and structures for output windows
+ */
+
 # include <stdarg.h>
 
 typedef struct vout_window_t vout_window_t;
index 1b600b7..20b0970 100644 (file)
 #ifndef VLC_XML_H
 #define VLC_XML_H
 
+/**
+ * \file
+ * This file defines functions and structures to handle xml tags in vlc
+ *
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif