]> git.sesse.net Git - vlc/commitdiff
libvlc: fix doxygen comments.
authorRémi Duraffort <ivoire@videolan.org>
Sun, 28 Feb 2010 14:03:01 +0000 (15:03 +0100)
committerRémi Duraffort <ivoire@videolan.org>
Sun, 28 Feb 2010 14:06:49 +0000 (15:06 +0100)
include/vlc/libvlc_media_player.h

index 3bbb6b9b489e206a07ef4f2b6ad84e210ab68c68..b8763ca6784cd9beef289412f61fdb7d7c9965ff 100644 (file)
@@ -433,6 +433,7 @@ VLC_PUBLIC_API int libvlc_media_player_set_rate( libvlc_media_player_t *p_mi, fl
  * Get current movie state
  *
  * \param p_mi the Media Player
+ * \return the current state of the media player (playing, paused, ...) \see libvlc_state_t
  */
 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *p_mi );
 
@@ -458,6 +459,7 @@ VLC_PUBLIC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_m
  * Is this media player seekable?
  *
  * \param p_mi the media player
+ * \return true if the media player can seek
  */
 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
 
@@ -465,6 +467,7 @@ VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi
  * Can this media player be paused?
  *
  * \param p_mi the media player
+ * \return true if the media player can pause
  */
 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi );