Use var_Inherit* instead of var_CreateGet*.

[vlc] / include / vlc / libvlc_media_list_player.h

diff --git a/include/vlc/libvlc_media_list_player.h b/include/vlc/libvlc_media_list_player.h
index e8d39aafdec02ef862ca9583ad89bc1a854baf40..bd7563585547ddd87484dc96516f7c3a7f904578 100644 (file)
--- a/include/vlc/libvlc_media_list_player.h
+++ b/include/vlc/libvlc_media_list_player.h
@@ -36,10 +36,13 @@ extern "C" {
 /*****************************************************************************
  * Media List Player
  *****************************************************************************/
-/** \defgroup libvlc_media_list_player libvlc_media_list_player
+/** \defgroup libvlc_media_list_player LibVLC media list player
  * \ingroup libvlc
- * LibVLC Media List Player, play a media_list. You can see that as a media
- * instance subclass
+ * The LibVLC media list player plays a @ref libvlc_media_list_t list of media,
+ * in a certain order.
+ * This is required to especially support playlist files.
+ * The normal @ref libvlc_media_player_t LibVLC media player can only play a
+ * single media, and does not handle playlist files properly.
  * @{
  */
 
@@ -76,6 +79,7 @@ VLC_PUBLIC_API void
  * Return the event manager of this media_list_player.
  *
  * \param p_mlp media list player instance
+ * \return the event manager
  */
 VLC_PUBLIC_API libvlc_event_manager_t *
     libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
@@ -91,6 +95,12 @@ VLC_PUBLIC_API void
                                      libvlc_media_list_player_t * p_mlp,
                                      libvlc_media_player_t * p_mi );
 
+/**
+ * Set the media list associated with the player
+ *
+ * \param p_mlp media list player instance
+ * \param p_mlist list of media
+ */
 VLC_PUBLIC_API void
     libvlc_media_list_player_set_media_list(
                                      libvlc_media_list_player_t * p_mlp,
@@ -141,6 +151,13 @@ VLC_PUBLIC_API
 int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t * p_mlp,
                                                 int i_index);
 
+/**
+ * Play the given media item
+ *
+ * \param p_mlp media list player instance
+ * \param p_md the media instance
+ * \return 0 upon success, -1 if the media is not part of the media list
+ */
 VLC_PUBLIC_API
 int libvlc_media_list_player_play_item(libvlc_media_list_player_t * p_mlp,
                                        libvlc_media_t * p_md);