Update Doc.

nickarora · Sep 11, 2019 · e4d2ecb · e4d2ecb
1 parent d7ce863
commit e4d2ecb
Show file tree

Hide file tree

Showing 15 changed files with 158 additions and 152 deletions.
diff --git a/SGPlayer/Classes/Core/SGAsset/SGAsset.h b/SGPlayer/Classes/Core/SGAsset/SGAsset.h
@@ -8,6 +8,14 @@
 
 #import <Foundation/Foundation.h>
 
+/*!
+ @class SGAsset
+ @abstract
+    Abstract class for asset.
+ 
+ @discussion
+    Use SGURLAsset or SGMutableAsset.
+ */
 @interface SGAsset : NSObject <NSCopying>
 
 @end
diff --git a/SGPlayer/Classes/Core/SGAsset/SGMutableAsset.h b/SGPlayer/Classes/Core/SGAsset/SGMutableAsset.h
@@ -12,13 +12,17 @@
 
 @interface SGMutableAsset : SGAsset
 
-/**
- *
- */
+/*!
+ @property tracks
+ @abstract
+    Provides array of SGMutableAsset tracks.
+*/
 @property (nonatomic, copy, readonly) NSArray<SGMutableTrack *> *tracks;
 
-/**
- *
+/*!
+ @method addTrack:
+ @abstract
+    Add a track to the asset.
  */
 - (SGMutableTrack *)addTrack:(SGMediaType)type;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGMutableTrack.h b/SGPlayer/Classes/Core/SGAsset/SGMutableTrack.h
@@ -12,13 +12,17 @@
 
 @interface SGMutableTrack : SGTrack
 
-/**
- *
+/*!
+ @property segments
+ @abstract
+    Provides array of SGMutableTrack segments.
  */
 @property (nonatomic, copy, readonly) NSArray<SGSegment *> *segments;
 
-/**
- *
+/*!
+ @method appendSegment:
+ @abstract
+    Append a segment to the track.
  */
 - (BOOL)appendSegment:(SGSegment *)segment;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGPaddingSegment.h b/SGPlayer/Classes/Core/SGAsset/SGPaddingSegment.h
@@ -10,8 +10,10 @@
 
 @interface SGPaddingSegment : SGSegment
 
-/**
- *
+/*!
+ @method initWithDuration:
+ @abstract
+    Initializes an SGPaddingSegment.
  */
 - (instancetype)initWithDuration:(CMTime)duration;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGSegment.h b/SGPlayer/Classes/Core/SGAsset/SGSegment.h
@@ -11,19 +11,20 @@
 
 @interface SGSegment : NSObject <NSCopying>
 
-/**
- *
- */
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
 
-/**
- *
+/*!
+ @property timeRange
+ @abstract
+    Indicates the timeRange of the segment.
  */
 @property (nonatomic, readonly) CMTimeRange timeRange;
 
-/**
- *
+/*!
+ @property scale
+ @abstract
+    Indicates the scale of the segment.
  */
 @property (nonatomic, readonly) CMTime scale;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGTrack.h b/SGPlayer/Classes/Core/SGAsset/SGTrack.h
@@ -11,19 +11,20 @@
 
 @interface SGTrack : NSObject <NSCopying>
 
-/**
- *
- */
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
 
-/**
- *
+/*!
+ @property type
+ @abstract
+    Indicates the track media type.
  */
 @property (nonatomic, readonly) SGMediaType type;
 
-/**
- *
+/*!
+ @property type
+ @abstract
+    Indicates the track index.
  */
 @property (nonatomic, readonly) NSInteger index;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGTrackSelection.h b/SGPlayer/Classes/Core/SGAsset/SGTrackSelection.h
@@ -9,23 +9,24 @@
 #import <Foundation/Foundation.h>
 #import "SGTrack.h"
 
-/**
- *
- */
 typedef NS_OPTIONS(NSUInteger, SGTrackSelectionAction) {
     SGTrackSelectionActionTracks  = 1 << 0,
     SGTrackSelectionActionWeights = 1 << 1,
 };
 
 @interface SGTrackSelection : NSObject <NSCopying>
 
-/**
- *
+/*!
+ @property tracks
+ @abstract
+    Provides array of SGTrackSelection tracks.
  */
 @property (nonatomic, copy) NSArray<SGTrack *> *tracks;
 
-/**
- *
+/*!
+ @property weights
+ @abstract
+    Provides array of SGTrackSelection weights.
  */
 @property (nonatomic, copy) NSArray<NSNumber *> *weights;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGURLAsset.h b/SGPlayer/Classes/Core/SGAsset/SGURLAsset.h
@@ -10,19 +10,20 @@
 
 @interface SGURLAsset : SGAsset
 
-/**
- *
- */
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
 
-/**
- *
+/*!
+ @method initWithURL:
+ @abstract
+    Initializes an SGURLAsset with an NSURL.
  */
 - (instancetype)initWithURL:(NSURL *)URL;
 
-/**
- *
+/*!
+ @property URL
+ @abstract
+    Indicates the URL of the asset.
  */
 @property (nonatomic, copy, readonly) NSURL *URL;
 

diff --git a/SGPlayer/Classes/Core/SGAsset/SGURLSegment.h b/SGPlayer/Classes/Core/SGAsset/SGURLSegment.h
@@ -10,23 +10,32 @@
 
 @interface SGURLSegment : SGSegment
 
-/**
- *
+/*!
+ @method initWithURL:index:
+ @abstract
+    Equivalent:
+        [self initWithURL:URL index:index timeRange:kCMTimeRangeInvalid scale:kCMTimeInvalid];
  */
 - (instancetype)initWithURL:(NSURL *)URL index:(NSInteger)index;
 
-/**
- *
+/*!
+ @method initWithURL:index:timeRange:scale:
+ @abstract
+    Initializes an SGURLSegment.
  */
 - (instancetype)initWithURL:(NSURL *)URL index:(NSInteger)index timeRange:(CMTimeRange)timeRange scale:(CMTime)scale;
 
-/**
- *
+/*!
+ @property URL
+ @abstract
+    Indicates the URL of the segment.
  */
 @property (nonatomic, copy, readonly) NSURL *URL;
 
-/**
- *
+/*!
+ @property type
+ @abstract
+    Indicates the index.
  */
 @property (nonatomic, readonly) NSInteger index;
 

diff --git a/SGPlayer/Classes/Core/SGCommon/SGError.h b/SGPlayer/Classes/Core/SGCommon/SGError.h
@@ -8,9 +8,6 @@
 
 #import <Foundation/Foundation.h>
 
-/**
- *
- */
 typedef NS_ENUM(NSUInteger, SGErrorCode) {
     SGErrorCodeUnknown = 0,
     SGErrorImmediateExitRequested,
@@ -23,9 +20,6 @@ typedef NS_ENUM(NSUInteger, SGErrorCode) {
     SGErrorCodeInvlidTime,
 };
 
-/**
- *
- */
 typedef NS_ENUM(NSUInteger, SGActionCode) {
     SGActionCodeUnknown = 0,
     SGActionCodeFormatCreate,
@@ -42,12 +36,5 @@ typedef NS_ENUM(NSUInteger, SGActionCode) {
     SGActionCodeSegmentDemuxerNext,
 };
 
-/**
- *
- */
 NSError * SGGetFFError(int result, SGActionCode operation);
-
-/**
- *
- */
 NSError * SGCreateError(NSUInteger code, SGActionCode operation);
diff --git a/SGPlayer/Classes/Core/SGCommon/SGTime.h b/SGPlayer/Classes/Core/SGCommon/SGTime.h
@@ -9,42 +9,13 @@
 #import <Foundation/Foundation.h>
 #import <CoreMedia/CoreMedia.h>
 
-/**
- *
- */
 BOOL SGCMTimeIsValid(CMTime time, BOOL infinity);
 
-/**
- *
- */
 CMTime SGCMTimeValidate(CMTime time, CMTime defaultTime, BOOL infinity);
-
-/**
- *
- */
 CMTime SGCMTimeMakeWithSeconds(Float64 seconds);
-
-/**
- *
- */
 CMTime SGCMTimeMultiply(CMTime time, CMTime multiplier);
-
-/**
- *
- */
 CMTime SGCMTimeDivide(CMTime time, CMTime divisor);
-
-/**
- *
- */
 CMTime SGCMTimeDivide(CMTime time, CMTime divisor);
 
-/**
- *
- */
 CMTimeRange SGCMTimeRangeFit(CMTimeRange timeRange);
-
-/**
- *
- */
 CMTimeRange SGCMTimeRangeGetIntersection(CMTimeRange timeRange1, CMTimeRange timeRange2);
diff --git a/SGPlayer/Classes/Core/SGData/SGCapacity.h b/SGPlayer/Classes/Core/SGData/SGCapacity.h
@@ -15,37 +15,11 @@ typedef struct SGCapacity {
     CMTime duration;
 } SGCapacity;
 
-/**
- *
- */
 SGCapacity SGCapacityCreate(void);
-
-/**
- *
- */
 SGCapacity SGCapacityAdd(SGCapacity c1, SGCapacity c2);
-
-/**
- *
- */
 SGCapacity SGCapacityMinimum(SGCapacity c1, SGCapacity c2);
-
-/**
- *
- */
 SGCapacity SGCapacityMaximum(SGCapacity c1, SGCapacity c2);
 
-/**
- *
- */
 BOOL SGCapacityIsEqual(SGCapacity c1, SGCapacity c2);
-
-/**
- *
- */
 BOOL SGCapacityIsEnough(SGCapacity c1);
-
-/**
- *
- */
 BOOL SGCapacityIsEmpty(SGCapacity c1);
diff --git a/SGPlayer/Classes/Core/SGDemuxer/SGURLDemuxer.h b/SGPlayer/Classes/Core/SGDemuxer/SGURLDemuxer.h
@@ -10,19 +10,20 @@
 
 @interface SGURLDemuxer : NSObject <SGDemuxable>
 
-/**
- *
- */
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
 
-/**
- *
+/*!
+ @method initWithURL:
+ @abstract
+    Initializes an SGURLDemuxer with an NSURL.
  */
 - (instancetype)initWithURL:(NSURL *)URL;
 
-/**
- *
+/*!
+ @property URL
+ @abstract
+    Indicates the URL of the demuxer.
  */
 @property (nonatomic, copy, readonly) NSURL *URL;