ThePain/Swiftgram
1
0
Fork 0
mirror of https://github.com/Swiftgram/Telegram-iOS.git synced 2025-12-24 07:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix -Wdocumentation warnings (#3113)

Browse Source
This commit is contained in:
Michael Schneider
2017-03-01 11:25:37 -08:00
committed by Adlai Holler
parent 71ebf6b029
commit 67baa44fb5
11 changed files with 30 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Source/ASVideoPlayerNode.h
View File

@@ -80,14 +80,14 @@ NS_ASSUME_NONNULL_BEGIN
@optional
/**
* @abstract Delegate method invoked before creating controlbar controls
* @param videoPlayer
* @param videoPlayer The sender
*/
- (NSArray *)videoPlayerNodeNeededDefaultControls:(ASVideoPlayerNode*)videoPlayer;
/**
* @abstract Delegate method invoked before creating default controls, asks delegate for custom controls dictionary.
* This dictionary must constain only ASDisplayNode subclass objects.
* @param videoPlayer
* @param videoPlayer The sender
* @discussion - This method is invoked only when developer implements videoPlayerNodeLayoutSpec:forControls:forMaximumSize:
* and gives ability to add custom constrols to ASVideoPlayerNode, for example mute button.
*/
@@ -95,7 +95,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
* @abstract Delegate method invoked in layoutSpecThatFits:
* @param videoPlayer
* @param videoPlayer The sender
* @param controls - Dictionary of controls which are used in videoPlayer; Dictionary keys are ASVideoPlayerNodeControlType
* @param maxSize - Maximum size for ASVideoPlayerNode
* @discussion - Developer can layout whole ASVideoPlayerNode as he wants. ASVideoNode is locked and it can't be changed
@@ -107,10 +107,10 @@ NS_ASSUME_NONNULL_BEGIN
#pragma mark Text delegate methods
/**
* @abstract Delegate method invoked before creating ASVideoPlayerNodeControlTypeElapsedText and ASVideoPlayerNodeControlTypeDurationText
* @param videoPlayer
* @param timeLabelType
* @param videoPlayer The sender
* @param timeLabelType The of the time label
*/
- (NSDictionary *)videoPlayerNodeTimeLabelAttributes:(ASVideoPlayerNode *)videoPlayerNode timeLabelType:(ASVideoPlayerNodeControlType)timeLabelType;
- (NSDictionary *)videoPlayerNodeTimeLabelAttributes:(ASVideoPlayerNode *)videoPlayer timeLabelType:(ASVideoPlayerNodeControlType)timeLabelType;
- (NSString *)videoPlayerNode:(ASVideoPlayerNode *)videoPlayerNode
timeStringForTimeLabelType:(ASVideoPlayerNodeControlType)timeLabelType
forTime:(CMTime)time;
@@ -136,7 +136,7 @@ NS_ASSUME_NONNULL_BEGIN
#pragma mark ASVideoNodeDelegate proxy methods
/**
* @abstract Delegate method invoked when ASVideoPlayerNode is taped.
* @param videoPlayerNode The ASVideoPlayerNode that was tapped.
* @param videoPlayer The ASVideoPlayerNode that was tapped.
*/
- (void)didTapVideoPlayerNode:(ASVideoPlayerNode *)videoPlayer;
@@ -148,23 +148,23 @@ NS_ASSUME_NONNULL_BEGIN
/**
* @abstract Delegate method invoked when ASVideoNode playback time is updated.
* @param videoPlayerNode The video player node
* @param second current playback time.
* @param videoPlayer The video player node
* @param time current playback time.
*/
- (void)videoPlayerNode:(ASVideoPlayerNode *)videoPlayer didPlayToTime:(CMTime)time;
/**
* @abstract Delegate method invoked when ASVideoNode changes state.
* @param videoPlayerNode The ASVideoPlayerNode whose ASVideoNode is changing state.
* @param videoPlayer The ASVideoPlayerNode whose ASVideoNode is changing state.
* @param state ASVideoNode state before this change.
* @param toSate ASVideoNode new state.
* @param toState ASVideoNode new state.
* @discussion This method is called after each state change
*/
- (void)videoPlayerNode:(ASVideoPlayerNode *)videoPlayer willChangeVideoNodeState:(ASVideoNodePlayerState)state toVideoNodeState:(ASVideoNodePlayerState)toState;
/**
* @abstract Delegate method is invoked when ASVideoNode decides to change state.
* @param videoPlayerNode The ASVideoPlayerNode whose ASVideoNode is changing state.
* @param videoPlayer The ASVideoPlayerNode whose ASVideoNode is changing state.
* @param state ASVideoNode that is going to be set.
* @discussion Delegate method invoked when player changes it's state to
* ASVideoNodePlayerStatePlaying or ASVideoNodePlayerStatePaused
@@ -188,7 +188,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
* @abstract Delegate method invoked when the ASVideoNode stalls.
* @param videoPlayer The video player node that has experienced the stall
* @param second Current playback time when the stall happens
* @param timeInterval Current playback time when the stall happens
*/
- (void)videoPlayerNode:(ASVideoPlayerNode *)videoPlayer didStallAtTimeInterval:(NSTimeInterval)timeInterval;