Add another bunch of doxygen file comments.

diff --git a/include/vlc/deprecated.h b/include/vlc/deprecated.h
index 4cf2bb77f914f5c3095965146ff6c6c7e0b1e203..c683ecb99f454ea73e63114ab87f05d454dde6bd 100644 (file)
--- a/include/vlc/deprecated.h
+++ b/include/vlc/deprecated.h
@@ -1,11 +1,11 @@
 /*****************************************************************************
  * deprecated.h:  libvlc deprecated API
  *****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Clément Stenac <zorglub@videolan.org>
- *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
+ *          Jean-Paul Saman <jpsaman@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,6 +25,11 @@
 #ifndef LIBVLC_DEPRECATED_H
 #define LIBVLC_DEPRECATED_H 1
 
+/**
+ * \file
+ * This file defines libvlc depreceated API
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif

diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index da8a66e5948549dce70e58f40eb69ef408de8158..7f2f384d446b47bc9688d1f984fecd3233713a67 100644 (file)
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -5,7 +5,7 @@
  * $Id$
  *
  * Authors: Clément Stenac <zorglub@videolan.org>
- *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
+ *          Jean-Paul Saman <jpsaman@videolan.org>
  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -23,6 +23,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines libvlc external API
+ */
+
 /**
  * \defgroup libvlc libvlc
  * This is libvlc, the base library of the VLC program.
@@ -30,7 +35,6 @@
  * @{
  */
 
-
 #ifndef VLC_LIBVLC_H
 #define VLC_LIBVLC_H 1
 
@@ -527,6 +531,7 @@ VLC_PUBLIC_API libvlc_drawable_t
                     libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
 
 /** \bug This might go away ... to be replaced by a broader system */
+
 /**
  * Get the current movie length (in ms).
  *
@@ -534,7 +539,8 @@ VLC_PUBLIC_API libvlc_drawable_t
  * \param p_e an initialized exception pointer
  * \return the movie length (in ms).
  */
-VLC_PUBLIC_API libvlc_time_t  libvlc_media_player_get_length     ( libvlc_media_player_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
+
 /**
  * Get the current movie time (in ms).
  *
@@ -542,7 +548,8 @@ VLC_PUBLIC_API libvlc_time_t  libvlc_media_player_get_length     ( libvlc_media_
  * \param p_e an initialized exception pointer
  * \return the movie time (in ms).
  */
-VLC_PUBLIC_API libvlc_time_t  libvlc_media_player_get_time       ( libvlc_media_player_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
+
 /**
  * Set the movie time (in ms).
  *
@@ -550,17 +557,90 @@ VLC_PUBLIC_API libvlc_time_t  libvlc_media_player_get_time       ( libvlc_media_
  * \param the movie time (in ms).
  * \param p_e an initialized exception pointer
  */
-VLC_PUBLIC_API void           libvlc_media_player_set_time       ( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
-VLC_PUBLIC_API float          libvlc_media_player_get_position   ( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void           libvlc_media_player_set_position   ( libvlc_media_player_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API void           libvlc_media_player_set_chapter    ( libvlc_media_player_t *, int, libvlc_exception_t *);
-VLC_PUBLIC_API int            libvlc_media_player_get_chapter    (libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API int            libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API int            libvlc_media_player_will_play      ( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float          libvlc_media_player_get_rate       ( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void           libvlc_media_player_set_rate       ( libvlc_media_player_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state   ( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float          libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
+
+/**
+ * Get movie position.
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return movie position
+ */
+VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Set movie position.
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return movie position
+ */
+VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
+
+/**
+ * Set movie chapter
+ *
+ * \param p_mi the Media Player
+ * \param i_chapter chapter number to play
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
+
+/**
+ * Get movie chapter
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return chapter number currently playing
+ */
+VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
+
+/**
+ * Get movie chapter count
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return number of chapters in movie
+ */
+VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
+VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Get movie play rate
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return movie play rate
+ */
+VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Set movie play rate
+ *
+ * \param p_mi the Media Player
+ * \param movie play rate to set
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
+
+/**
+ * Get current movie state
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return current movie state as libvlc_state_t
+ */
+VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Get movie fps rate
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return frames per second (fps) for this playing movie
+ */
+VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
+
 /** end bug */
 
 /**

diff --git a/include/vlc/libvlc_events.h b/include/vlc/libvlc_events.h
index f40479fbdb5cf6e228dd494b49f0135159642e5f..1aa0f2f5fdc34c796292fe9aec2a70306f51652b 100644 (file)
--- a/include/vlc/libvlc_events.h
+++ b/include/vlc/libvlc_events.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc_events.h:  libvlc_events external API structure
  *****************************************************************************
- * Copyright (C) 1998-2007 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id $
  *
  * Authors: Filippo Carone <littlejohn@videolan.org>
@@ -25,6 +25,11 @@
 #ifndef LIBVLC_EVENTS_H
 #define LIBVLC_EVENTS_H 1
 
+/**
+ * \file
+ * This file defines libvlc_event external API
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif

diff --git a/include/vlc/libvlc_media_list.h b/include/vlc/libvlc_media_list.h
index c263c5149ad3ea870689fac4afca5f5720fb8221..1b55b79ecf3fa03348f27dce7d63ad48643ba22e 100644 (file)
--- a/include/vlc/libvlc_media_list.h
+++ b/include/vlc/libvlc_media_list.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc_media_list.h:  libvlc_media_list API
  *****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Pierre d'Herbemont
@@ -24,6 +24,11 @@
 #ifndef LIBVLC_MEDIA_LIST_H
 #define LIBVLC_MEDIA_LIST_H 1
 
+/**
+ * \file
+ * This file defines libvlc_media_list API
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif

diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h
index 125501e4c28bed2b6f8319aa585eb8b64e26f828..76427ad3cf9aa8ec98d4ef487534459746fea31e 100644 (file)
--- a/include/vlc/libvlc_structures.h
+++ b/include/vlc/libvlc_structures.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc.h:  libvlc_* new external API structures
  *****************************************************************************
- * Copyright (C) 1998-2007 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id $
  *
  * Authors: Filippo Carone <littlejohn@videolan.org>
@@ -24,6 +24,11 @@
 #ifndef LIBVLC_STRUCTURES_H
 #define LIBVLC_STRUCTURES_H 1
 
+/**
+ * \file
+ * This file defines libvlc_* new external API structures
+ */
+
 #include <stdint.h>
 
 # ifdef __cplusplus

diff --git a/include/vlc/libvlc_vlm.h b/include/vlc/libvlc_vlm.h
index 08fe7cb0cfd587d26eb374112ca54b7db4d155fb..de314e4095d61ad53dc4763d1f687f5bb9b6848d 100644 (file)
--- a/include/vlc/libvlc_vlm.h
+++ b/include/vlc/libvlc_vlm.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc_vlm.h:  libvlc_* new external API
  *****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Clément Stenac <zorglub@videolan.org>
@@ -25,6 +25,11 @@
 #ifndef LIBVLC_VLM_H
 #define LIBVLC_VLM_H 1
 
+/**
+ * \file
+ * This file defines libvlc_vlm_* external API
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif

diff --git a/include/vlc/mediacontrol.h b/include/vlc/mediacontrol.h
index 0ff0c5d0de0803c3f6cfcb5387198dd4b0e5086e..7f044554b5d3b83dd51f79b59622297bf8b38abf 100644 (file)
--- a/include/vlc/mediacontrol.h
+++ b/include/vlc/mediacontrol.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * control.h: global header for mediacontrol
+ * mediacontrol.h: global header for mediacontrol
  *****************************************************************************
- * Copyright (C) 2005 the VideoLAN team
+ * Copyright (C) 2005-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
@@ -21,6 +21,11 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines libvlc mediacontrol_* external API
+ */
+
 /**
  * \defgroup mediacontrol MediaControl
  * This is the MediaControl API, * intended to provide a generic API to movie players.

diff --git a/include/vlc/mediacontrol_structures.h b/include/vlc/mediacontrol_structures.h
index b2e42d4039f4f5adae98ac734e0032a18e5ba83f..30dea59e0d2b7385875a8a76a0723e42f91feced 100644 (file)
--- a/include/vlc/mediacontrol_structures.h
+++ b/include/vlc/mediacontrol_structures.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * control_structures.h: global header for mediacontrol
+ * mediacontrol_structures.h: global header for mediacontrol
  *****************************************************************************
- * Copyright (C) 2005 the VideoLAN team
+ * Copyright (C) 2005-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
@@ -20,6 +20,12 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
+
+/**
+ * \file
+ * This file defines libvlc mediacontrol_* data structures
+ */
+
 /**
  * \defgroup mediacontrol_structures MediaControl Structures
  * Data structures used in the MediaControl API.

diff --git a/include/vlc/vlc.h b/include/vlc/vlc.h
index 8527559d14317f20c0d97f58b61b5e1ddd57a59d..489b8d2f31ed43ee10e294717c80ab6e9497aa8a 100644 (file)
--- a/include/vlc/vlc.h
+++ b/include/vlc/vlc.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * vlc.h: global header for libvlc
  *****************************************************************************
- * Copyright (C) 1998-2004 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
@@ -28,6 +28,11 @@
 #ifndef VLC_VLC_H
 #define VLC_VLC_H 1
 
+/**
+ * \file
+ * This file defines libvlc new external API
+ */
+
 # ifdef __cplusplus
 extern "C" {
 # endif