vlc | branch: master | Rémi Denis-Courmont <[email protected]> | Sun Jun 14 23:25:38 2015 +0300| [aee51fec5a88e3eb68d84e9cb2ad699dbc6d9e38] | committer: Rémi Denis-Courmont
include: add/fix more Doxygen groups > http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=aee51fec5a88e3eb68d84e9cb2ad699dbc6d9e38 --- include/vlc_aout.h | 7 ++++++- include/vlc_aout_volume.h | 13 +++++++++---- include/vlc_codec.h | 4 ++-- include/vlc_dialog.h | 4 ++++ include/vlc_es_out.h | 1 + include/vlc_filter.h | 1 + include/vlc_interface.h | 6 +++--- include/vlc_sout.h | 33 +++++++++++++++++++++++++-------- include/vlc_spu.h | 4 ++-- include/vlc_stream.h | 1 + include/vlc_update.h | 3 ++- include/vlc_vout.h | 2 ++ include/vlc_vout_display.h | 18 ++++++++++++------ include/vlc_vout_osd.h | 12 +++++++++--- include/vlc_vout_window.h | 14 +++++++++----- 15 files changed, 88 insertions(+), 35 deletions(-) diff --git a/include/vlc_aout.h b/include/vlc_aout.h index b6546ab..630be72 100644 --- a/include/vlc_aout.h +++ b/include/vlc_aout.h @@ -24,8 +24,11 @@ #define VLC_AOUT_H 1 /** + * \defgroup audio_output Audio output + * \ingroup output + * @{ * \file - * This file defines functions, structures and macros for audio output object + * Audio output modules interface */ /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME @@ -336,4 +339,6 @@ VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, int rate); VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ); +/** @} */ + #endif /* VLC_AOUT_H */ diff --git a/include/vlc_aout_volume.h b/include/vlc_aout_volume.h index 051413b..df85b8f 100644 --- a/include/vlc_aout_volume.h +++ b/include/vlc_aout_volume.h @@ -25,15 +25,18 @@ #ifndef VLC_AOUT_MIXER_H #define VLC_AOUT_MIXER_H 1 +#ifdef __cplusplus +extern "C" { +#endif + /** + * \defgroup audio_volume Audio output volume + * \ingroup audio_output + * @{ * \file * This file defines functions, structures and macros for audio output mixer object */ -#ifdef __cplusplus -extern "C" { -#endif - typedef struct audio_volume audio_volume_t; /** @@ -47,6 +50,8 @@ struct audio_volume void (*amplify)(audio_volume_t *, block_t *, float); /**< Amplifier */ }; +/** @} */ + #ifdef __cplusplus } #endif diff --git a/include/vlc_codec.h b/include/vlc_codec.h index aebcf4c..6d385b4 100644 --- a/include/vlc_codec.h +++ b/include/vlc_codec.h @@ -29,8 +29,6 @@ #include <vlc_picture.h> #include <vlc_subpicture.h> -typedef struct decoder_owner_sys_t decoder_owner_sys_t; - /** * \defgroup codec Codec * Decoders and encoders @@ -43,6 +41,8 @@ typedef struct decoder_owner_sys_t decoder_owner_sys_t; * @{ */ +typedef struct decoder_owner_sys_t decoder_owner_sys_t; + /* * BIG FAT WARNING : the code relies in the first 4 members of filter_t * and decoder_t to be the same, so if you have anything to add, do it diff --git a/include/vlc_dialog.h b/include/vlc_dialog.h index 168bea4..f6070bb 100644 --- a/include/vlc_dialog.h +++ b/include/vlc_dialog.h @@ -23,6 +23,8 @@ # include <stdarg.h> /** + * \ingroup interaction + * @{ * \file vlc_dialog.h * User interaction dialog APIs */ @@ -121,4 +123,6 @@ VLC_API int dialog_Unregister(vlc_object_t *); #define dialog_Register(o) dialog_Register(VLC_OBJECT(o)) #define dialog_Unregister(o) dialog_Unregister(VLC_OBJECT(o)) +/** @} */ + #endif diff --git a/include/vlc_es_out.h b/include/vlc_es_out.h index aa6b427..58059f2 100644 --- a/include/vlc_es_out.h +++ b/include/vlc_es_out.h @@ -26,6 +26,7 @@ /** * \defgroup es_out ES output + * \ingroup input * Elementary streams output * @{ * \file diff --git a/include/vlc_filter.h b/include/vlc_filter.h index 418f5ba..dfb4b6a 100644 --- a/include/vlc_filter.h +++ b/include/vlc_filter.h @@ -32,6 +32,7 @@ /** * \defgroup filter Filters + * \ingroup output * Audio, video, text filters * @{ * \file diff --git a/include/vlc_interface.h b/include/vlc_interface.h index 5386269..80d7043 100644 --- a/include/vlc_interface.h +++ b/include/vlc_interface.h @@ -33,7 +33,7 @@ extern "C" { typedef struct intf_dialog_args_t intf_dialog_args_t; /** - * \defgroup vlc_interface Interface + * \defgroup interface Interface * VLC user interfaces * @{ * \file @@ -241,8 +241,8 @@ typedef enum vlc_dialog { "*.dks;*.pjs;*.mpl2;*.mks;" \ "*.vtt" -/** \defgroup vlc_interaction Interaction - * \ingroup vlc_interface +/** \defgroup interaction Interaction + * \ingroup interface * Interaction between user and modules * @{ */ diff --git a/include/vlc_sout.h b/include/vlc_sout.h index bba9446..e4cc0e8 100644 --- a/include/vlc_sout.h +++ b/include/vlc_sout.h @@ -28,11 +28,6 @@ #ifndef VLC_SOUT_H_ #define VLC_SOUT_H_ -/** - * \file - * This file defines structures and functions for stream output in vlc - */ - #ifdef __cplusplus extern "C" { #endif @@ -40,6 +35,14 @@ extern "C" { #include <sys/types.h> #include <vlc_es.h> +/** + * \defgroup sout Stream output + * \ingroup output + * @{ + * \file + * Stream output modules interface + */ + /** Stream output instance (FIXME: should be private to src/ to avoid * invalid unsynchronized access) */ struct sout_instance_t @@ -60,6 +63,12 @@ struct sout_instance_t ****************************************************************************/ typedef struct sout_stream_id_sys_t sout_stream_id_sys_t; +/** + * \defgroup sout_access Access output + * Raw output byte streams + * @{ + */ + /** Stream output access_output */ struct sout_access_out_t { @@ -101,6 +110,13 @@ static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao ) return b; } +/** + * @} + * \defgroup sout_mux Multiplexer + * Multiplexers (file formatters) + * @{ + */ + /** Muxer structure */ struct sout_mux_t { @@ -171,9 +187,8 @@ static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... ) return i_result; } -/**************************************************************************** - * sout_stream: - ****************************************************************************/ +/** @} */ + struct sout_stream_t { VLC_COMMON_MEMBERS @@ -250,6 +265,8 @@ typedef struct sout_description_data_t vlc_sem_t *sem; } sout_description_data_t; +/** @} */ + #ifdef __cplusplus } #endif diff --git a/include/vlc_spu.h b/include/vlc_spu.h index 39be789..cfaabd7 100644 --- a/include/vlc_spu.h +++ b/include/vlc_spu.h @@ -34,9 +34,9 @@ extern "C" { /** * \defgroup spu Sub-picture channels - * \ingroup subpicture - * \file + * \ingroup video_output * @{ + * \file */ typedef struct spu_private_t spu_private_t; diff --git a/include/vlc_stream.h b/include/vlc_stream.h index be44c4c..d76eb18 100644 --- a/include/vlc_stream.h +++ b/include/vlc_stream.h @@ -34,6 +34,7 @@ extern "C" { * \defgroup stream Stream * \ingroup input * Buffered input byte streams + * @{ * \file * Byte streams and byte stream filter modules interface */ diff --git a/include/vlc_update.h b/include/vlc_update.h index e84c927..df74405 100644 --- a/include/vlc_update.h +++ b/include/vlc_update.h @@ -27,10 +27,11 @@ /** * \defgroup update Software updates + * \ingroup interface * Over-the-air VLC software updates + * @{ * \file *VLC software update interface - * @{ */ #ifdef UPDATE_CHECK diff --git a/include/vlc_vout.h b/include/vlc_vout.h index 189fa09..8d7fb32 100644 --- a/include/vlc_vout.h +++ b/include/vlc_vout.h @@ -31,7 +31,9 @@ #include <vlc_subpicture.h> /** + * \defgroup output Output * \defgroup video_output Video output + * \ingroup output * Video rendering, output and window management * * This module describes the programming interface for video output threads. diff --git a/include/vlc_vout_display.h b/include/vlc_vout_display.h index a95f98d..817f770 100644 --- a/include/vlc_vout_display.h +++ b/include/vlc_vout_display.h @@ -24,11 +24,6 @@ #ifndef VLC_VOUT_DISPLAY_H #define VLC_VOUT_DISPLAY_H 1 -/** - * \file - * This file defines vout display structures and functions in vlc - */ - #include <vlc_es.h> #include <vlc_picture.h> #include <vlc_picture_pool.h> @@ -37,6 +32,16 @@ #include <vlc_mouse.h> #include <vlc_vout_window.h> +/** + * \defgroup video_display Video output display + * Video output display: output buffers and rendering + * + * \ingroup video_output + * @{ + * \file + * Video output display modules interface + */ + /* XXX * Do NOT use video_format_t::i_aspect but i_sar_num/den everywhere. i_aspect * will be removed as soon as possible. @@ -456,5 +461,6 @@ VLC_API void vout_display_PlacePicture(vout_display_place_t *place, const video_ */ VLC_API void vout_display_SendMouseMovedDisplayCoordinates(vout_display_t *vd, video_orientation_t orient_display, int m_x, int m_y, vout_display_place_t *place); -#endif /* VLC_VOUT_DISPLAY_H */ +/** @} */ +#endif /* VLC_VOUT_DISPLAY_H */ diff --git a/include/vlc_vout_osd.h b/include/vlc_vout_osd.h index 74d7937..22fe7bf 100644 --- a/include/vlc_vout_osd.h +++ b/include/vlc_vout_osd.h @@ -33,6 +33,14 @@ extern "C" { #endif /** + * \defgroup osd On-screen display + * \ingroup spu + * @{ + * \file + * Overlay text and widgets + */ + +/** * OSD menu position and picture type defines */ enum @@ -47,9 +55,6 @@ enum OSD_VERT_SLIDER, }; -/********************************************************************** - * Vout text and widget overlays - **********************************************************************/ VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * ); /** @@ -90,6 +95,7 @@ VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short ); */ VLC_API void vout_OSDIcon( vout_thread_t *, int, short ); +/** @} */ #ifdef __cplusplus } #endif diff --git a/include/vlc_vout_window.h b/include/vlc_vout_window.h index 1b766f5..44201d6 100644 --- a/include/vlc_vout_window.h +++ b/include/vlc_vout_window.h @@ -25,15 +25,18 @@ #ifndef VLC_VOUT_WINDOW_H #define VLC_VOUT_WINDOW_H 1 +#include <stdarg.h> +#include <vlc_common.h> + /** + * \defgroup video_window Video window + * \ingroup video_output + * Video output window management + * @{ * \file - * This file defines vout windows structures and functions in vlc + * Video output window modules interface */ -#include <stdarg.h> -#include <vlc_common.h> - -/* */ typedef struct vout_window_t vout_window_t; typedef struct vout_window_sys_t vout_window_sys_t; @@ -207,4 +210,5 @@ static inline void vout_window_ReportClose(vout_window_t *window) window->owner.closed(window); } +/** @} */ #endif /* VLC_VOUT_WINDOW_H */ _______________________________________________ vlc-commits mailing list [email protected] https://mailman.videolan.org/listinfo/vlc-commits
