Ver código fonte

Fix documentation of deprecated API calls

Felix Paul Kühne 9 anos atrás
pai
commit
b9c5f19175

+ 1 - 1
Headers/Public/VLCAudio.h

@@ -45,7 +45,7 @@ extern NSString *const VLCMediaPlayerVolumeChanged;
 
 /**
  * Mute the current audio output.
- * \note This selector is deprecated and will be removed in the next release */
+ * \deprecated This selector will be removed in the next release */
 - (void)setMute:(BOOL)value __attribute__((deprecated));
 
 /**

+ 3 - 3
Headers/Public/VLCMedia.h

@@ -231,7 +231,7 @@ typedef NS_ENUM(NSUInteger, VLCMediaType) {
 
 /**
  * Determines if the media has already been preparsed.
- * \note: deprecated: use parseStatus instead
+ * \deprecated use parseStatus instead
  */
 @property (nonatomic, readonly) BOOL isParsed __attribute__((deprecated));
 
@@ -447,7 +447,7 @@ extern NSString *const VLCMediaTracksInformationTypeUnknown;
  * is called.
  *
  * \see -[VLCMediaDelegate mediaDidFinishParsing:]
- * \note Use parseWithOptions: instead
+ * \deprecated Use parseWithOptions: instead
  */
 - (void)parse __attribute__((deprecated));
 
@@ -455,7 +455,7 @@ extern NSString *const VLCMediaTracksInformationTypeUnknown;
  * Trigger a synchronous parsing of the media
  * the selector won't return until parsing finished
  *
- * \note Use parseWithOptions: instead
+ * \deprecated Use parseWithOptions: instead
  */
 - (void)synchronousParse __attribute__((deprecated));
 

+ 5 - 2
Headers/Public/VLCMediaDiscoverer.h

@@ -54,7 +54,9 @@ extern NSString *const VLCMediaDiscovererCategory;
 @property (nonatomic, readonly) VLCLibrary *libraryInstance;
 
 /**
- * \return returns an empty array, will be removed in subsequent releases
+ * The full list of available media discoverers
+ * \return returns an empty array for binary compatibility, will be removed in subsequent releases
+ * \deprecated use availableMediaDiscovererForCategoryType instead
  */
 + (NSArray *)availableMediaDiscoverer __attribute__((deprecated));
 
@@ -96,7 +98,8 @@ extern NSString *const VLCMediaDiscovererCategory;
 @property (weak, readonly) VLCMediaList *discoveredMedia;
 
 /**
- * returns the localized name of the discovery module if available, otherwise in US English
+ * localized name of the discovery module if available, otherwise in US English
+ * \deprecated Will be removed in the next major release, may return an empty string for binary compatibility
  */
 @property (readonly, copy) NSString *localizedName __attribute__((deprecated));
 

+ 1 - 1
Headers/Public/VLCMediaListPlayer.h

@@ -68,7 +68,7 @@ typedef NS_ENUM(NSInteger, VLCRepeatMode) {
 
 /**
  * play an item at at a given index in the media list attached to the player
- * \note This method is not thread safe and is deprecated. Use playItemAtNumber: instead
+ * \deprecated This method is not thread safe. Use playItemAtNumber: instead
  */
 - (BOOL)playItemAtIndex:(int)index  __attribute__((deprecated));
 

+ 16 - 3
Headers/Public/VLCMediaPlayer.h

@@ -268,8 +268,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
 /**
  * Frames per second
- * \note Deprecated, provided for API compatibility only
- * \note To retrieve a media's FPS, use VLCMediaTracksInformationFrameRate.
+ * \deprecated provided for API compatibility only, to retrieve a media's FPS, use VLCMediaTracksInformationFrameRate.
  * \returns 0
  */
 @property (NS_NONATOMIC_IOSONLY, readonly) float framesPerSecond __attribute__((deprecated));
@@ -352,7 +351,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
  * \param path to a file
  * \return if the call succeed..
  *
- * \note use addPlaybackSlave:type:enforce: instead
+ * \deprecated use addPlaybackSlave:type:enforce: instead
  */
 - (BOOL)openVideoSubTitlesFromFile:(NSString *)path __attribute__((deprecated));
 
@@ -398,6 +397,11 @@ typedef NS_ENUM(unsigned, VLCMediaPlaybackSlaveType)
 - (void)previousChapter;
 - (void)nextChapter;
 - (int)numberOfChaptersForTitle:(int)titleIndex;
+
+/**
+ * Chapters of a given title index
+ * \deprecated Use chapterDescriptionsOfTitle instead
+ */
 - (NSArray *)chaptersForTitleIndex:(int)titleIndex __attribute__((deprecated));
 
 extern NSString *const VLCChapterDescriptionName;
@@ -419,7 +423,16 @@ extern NSString *const VLCChapterDescriptionDuration;
  */
 @property (readwrite) int currentTitleIndex;
 @property (readonly) int numberOfTitles;
+
+/**
+ * count of titles
+ * \deprecated Use numberOfTitles instead
+ */
 @property (readonly) NSUInteger countOfTitles __attribute__((deprecated));
+/**
+ * array of available titles
+ * \deprecated Use titleDescriptions instead
+ */
 @property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray *titles __attribute__((deprecated));
 
 extern NSString *const VLCTitleDescriptionName;