[vlc-devel] commit: libvlc: fix doxygen comments. ( Rémi Duraffort )

[git version control]

vlc | branch: master | Rémi Duraffort <ivoire at videolan.org> | Sun Feb 28 15:03:01 2010 +0100| [880c1d98801b4edd0330145ab2a98d3edf575c59] | committer: Rémi Duraffort 

libvlc: fix doxygen comments.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=880c1d98801b4edd0330145ab2a98d3edf575c59
---

 include/vlc/libvlc_media_player.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h
index 3bbb6b9..b8763ca 100644
--- a/include/vlc/libvlc_media_player.h
+++ b/include/vlc/libvlc_media_player.h
@@ -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 );