[vlc-devel] commit: macosx/framework: improve comments in VLCMediaPlayer.h. (Pierre d' Herbemont )

[git version control]

vlc | branch: master | Pierre d'Herbemont <pdherbemont at free.fr> | Mon Dec 21 15:16:52 2009 +0100| [9654fccc6af86c30a536b26ad816428dbb218109] | committer: Pierre d'Herbemont 

macosx/framework: improve comments in VLCMediaPlayer.h.

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

 .../framework/Headers/Public/VLCMediaPlayer.h      |   25 +++++++++++++++++--
 1 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h b/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h
index 92e6c77..efa8414 100644
--- a/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h
+++ b/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h
@@ -157,12 +157,18 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 @property (readonly) int fps;
 
 /**
- * Return the current video subtitle index, or
- * \return NSNotFound if none is set.
+ * Return the current video subtitle index
+ * \return 0 if none is set.
  *
- * To disable subtitle pass NSNotFound.
+ * Pass 0 to disable.
  */
 @property (readwrite) NSUInteger currentVideoSubTitleIndex;
+
+/**
+ * Return the video subtitle tracks
+ *
+ * It includes the disabled fake track at index 0.
+ */
 - (NSArray *)videoSubTitles;
 
 /**
@@ -196,7 +202,20 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 - (NSArray *)titles;
 
 /* Audio Options */
+
+/**
+ * Return the current audio track index
+ * \return 0 if none is set.
+ *
+ * Pass 0 to disable.
+ */
 @property (readwrite) NSUInteger currentAudioTrackIndex;
+
+/**
+ * Return the audio tracks
+ *
+ * It includes the "Disable" fake track at index 0.
+ */
 - (NSArray *)audioTracks;
 
 - (void)setAudioChannel:(int)value;