]> git.sesse.net Git - vlc/commitdiff
Fix doxygen documentation.
authorRémi Duraffort <ivoire@videolan.org>
Sun, 28 Feb 2010 22:03:41 +0000 (23:03 +0100)
committerRémi Duraffort <ivoire@videolan.org>
Sun, 28 Feb 2010 22:07:09 +0000 (23:07 +0100)
include/vlc/libvlc_media_list_player.h

index 3a1f913b6a538cef5d86e620744ff21ebb44803e..bd7563585547ddd87484dc96516f7c3a7f904578 100644 (file)
@@ -79,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);
@@ -94,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,
@@ -144,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);