Add a bunch of \file doxygen comments

include/vlc_access.h

@@ -24,6 +24,11 @@
 #ifndef VLC_ACCESS_H
 #define VLC_ACCESS_H 1
 
+/**
+ * \file
+ * This file defines functions and definitions for access object
+ */
+
 #include <vlc_block.h>
 
 /**

include/vlc_aout.h

@@ -24,6 +24,11 @@
 #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
  */

include/vlc_arrays.h

@@ -24,6 +24,11 @@
 #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
  */

include/vlc_bits.h

@@ -24,6 +24,11 @@
 #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 )

include/vlc_block.h

@@ -24,6 +24,12 @@
 #ifndef VLC_BLOCK_H
 #define VLC_BLOCK_H 1
 
+/**
+ * \file
+ * This file implements functions and structures to handle blocks of data in vlc
+ *
+ */
+
 /****************************************************************************
  * block:
  ****************************************************************************

include/vlc_charset.h

@@ -25,6 +25,11 @@
 #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>

include/vlc_codecs.h

@@ -24,6 +24,11 @@
 #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

include/vlc_config.h

@@ -22,6 +22,11 @@
  * 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
  * ----------------------------------------------------
  *

include/vlc_configuration.h

@@ -26,6 +26,11 @@
 #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" {

include/vlc_demux.h

@@ -24,6 +24,11 @@
 #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>

include/vlc_devices.h

@@ -24,6 +24,11 @@
 #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,

include/vlc_epg.h

@@ -24,6 +24,11 @@
 #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;

include/vlc_es_out.h

@@ -24,6 +24,11 @@
 #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;

include/vlc_gcrypt.h

@@ -18,6 +18,11 @@
  * 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
  */

include/vlc_httpd.h

@@ -24,6 +24,11 @@
 #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,

include/vlc_image.h

@@ -24,6 +24,11 @@
 #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

include/vlc_input.h

@@ -26,6 +26,11 @@
 #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>

include/vlc_intf_strings.h

@@ -24,6 +24,11 @@
 #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...")

include/vlc_iso_lang.h

@@ -22,6 +22,11 @@
  * 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 */

include/vlc_keys.h

@@ -24,6 +24,12 @@
 #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