From: Pierre d'Herbemont <pdherbemont@free.fr>
Date: Mon, 21 Dec 2009 14:16:52 +0000 (+0100)
Subject: macosx/framework: improve comments in VLCMediaPlayer.h.
X-Git-Tag: 1.1.0-ff~1786
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=9654fccc6af86c30a536b26ad816428dbb218109;p=vlc

macosx/framework: improve comments in VLCMediaPlayer.h.
---

diff --git a/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h b/projects/macosx/framework/Headers/Public/VLCMediaPlayer.h
index 92e6c77b97..efa841477f 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;