mirror of
https://github.com/Swiftgram/Telegram-iOS.git
synced 2025-12-15 18:59:54 +00:00
Correct a few documentation comments for method parameters
This commit is contained in:
parent
5c28bb8e21
commit
86ccd33a84
@ -173,7 +173,7 @@ NS_ASSUME_NONNULL_BEGIN
|
||||
/**
|
||||
* Registers the given kind of supplementary node for use in creating node-backed supplementary views.
|
||||
*
|
||||
* @param kind The kind of supplementary node that will be requested through the data source.
|
||||
* @param elementKind The kind of supplementary node that will be requested through the data source.
|
||||
*
|
||||
* @discussion Use this method to register support for the use of supplementary nodes in place of the default
|
||||
* `registerClass:forSupplementaryViewOfKind:withReuseIdentifier:` and `registerNib:forSupplementaryViewOfKind:withReuseIdentifier:`
|
||||
|
||||
@ -18,8 +18,8 @@
|
||||
/**
|
||||
* Inform that the collectionView is editing the cells at a list of indexPaths
|
||||
*
|
||||
* @param indexPaths, an array of NSIndexPath objects of cells being/will be edited.
|
||||
* @param isBatched, indicates whether the editing operation will be batched by the collectionView
|
||||
* @param indexPaths an array of NSIndexPath objects of cells being/will be edited.
|
||||
* @param isBatched indicates whether the editing operation will be batched by the collectionView
|
||||
*
|
||||
* NOTE: when isBatched, used in combination with -collectionViewWillPerformBatchUpdates
|
||||
*/
|
||||
@ -28,10 +28,10 @@
|
||||
/**
|
||||
* Inform that the collectionView is editing the sections at a set of indexes
|
||||
*
|
||||
* @param indexes, an NSIndexSet of section indexes being/will be edited.
|
||||
* @param isBatched, indicates whether the editing operation will be batched by the collectionView
|
||||
* @param indexes an NSIndexSet of section indexes being/will be edited.
|
||||
* @param batched indicates whether the editing operation will be batched by the collectionView
|
||||
*
|
||||
* NOTE: when isBatched, used in combination with -collectionViewWillPerformBatchUpdates
|
||||
* NOTE: when batched, used in combination with -collectionViewWillPerformBatchUpdates
|
||||
*/
|
||||
- (void)collectionViewWillEditSectionsAtIndexSet:(NSIndexSet *)indexes batched:(BOOL)batched;
|
||||
|
||||
|
||||
@ -122,7 +122,7 @@ typedef NS_OPTIONS(NSUInteger, ASControlState) {
|
||||
|
||||
/**
|
||||
Class method to enable a visualization overlay of the tapable area on the ASControlNode. For app debugging purposes only.
|
||||
@param enabled Specify YES to make this debug feature enabled when messaging the ASControlNode class.
|
||||
@param enable Specify YES to make this debug feature enabled when messaging the ASControlNode class.
|
||||
*/
|
||||
+ (void)setEnableHitTestDebug:(BOOL)enable;
|
||||
@end
|
||||
|
||||
@ -63,7 +63,7 @@ id<NSCopying> _ASControlNodeEventKeyForControlEvent(ASControlNodeEvent controlEv
|
||||
@abstract Enumerates the ASControlNode events included mask, invoking the block for each event.
|
||||
@param mask An ASControlNodeEvent mask.
|
||||
@param block The block to be invoked for each ASControlNodeEvent included in mask.
|
||||
@param anEvent An even that is included in mask.
|
||||
@param anEvent An even that is included in mask.
|
||||
*/
|
||||
void _ASEnumerateControlEventsIncludedInMaskWithBlock(ASControlNodeEvent mask, void (^block)(ASControlNodeEvent anEvent));
|
||||
|
||||
|
||||
@ -131,7 +131,7 @@ asimagenode_modification_block_t ASImageNodeRoundBorderModificationBlock(CGFloat
|
||||
* @abstract Image modification block that applies a tint color à la UIImage configured with
|
||||
* renderingMode set to UIImageRenderingModeAlwaysTemplate.
|
||||
*
|
||||
* @param tintColor The color to tint the image.
|
||||
* @param color The color to tint the image.
|
||||
*
|
||||
* @see <imageModificationBlock>
|
||||
*
|
||||
|
||||
@ -55,7 +55,7 @@
|
||||
/**
|
||||
* Provides the constrained size range for measuring the node at the index path.
|
||||
*
|
||||
* @param collectionView The sender.
|
||||
* @param pagerNode The sender.
|
||||
*
|
||||
* @param indexPath The index path of the node.
|
||||
*
|
||||
|
||||
@ -22,7 +22,7 @@ typedef void(^ASImageCacherCompletion)(UIImage * _Nullable imageFromCache);
|
||||
@param URL The URL of the image to retrieve from the cache.
|
||||
@param callbackQueue The queue to call `completion` on.
|
||||
@param completion The block to be called when the cache has either hit or missed.
|
||||
@param imageFromCache The image that was retrieved from the cache, if the image could be retrieved; nil otherwise.
|
||||
@param imageFromCache The image that was retrieved from the cache, if the image could be retrieved; nil otherwise.
|
||||
@discussion If `URL` is nil, `completion` will be invoked immediately with a nil image. This method should not block
|
||||
the calling thread as it is likely to be called from the main thread.
|
||||
*/
|
||||
@ -70,10 +70,10 @@ typedef NS_ENUM(NSUInteger, ASImageDownloaderPriority) {
|
||||
@param URL The URL of the image to download.
|
||||
@param callbackQueue The queue to call `downloadProgressBlock` and `completion` on.
|
||||
@param downloadProgress The block to be invoked when the download of `URL` progresses.
|
||||
@param progress The progress of the download, in the range of (0.0, 1.0), inclusive.
|
||||
@param progress The progress of the download, in the range of (0.0, 1.0), inclusive.
|
||||
@param completion The block to be invoked when the download has completed, or has failed.
|
||||
@param image The image that was downloaded, if the image could be successfully downloaded; nil otherwise.
|
||||
@param error An error describing why the download of `URL` failed, if the download failed; nil otherwise.
|
||||
@param image The image that was downloaded, if the image could be successfully downloaded; nil otherwise.
|
||||
@param error An error describing why the download of `URL` failed, if the download failed; nil otherwise.
|
||||
@discussion This method is likely to be called on the main thread, so any custom implementations should make sure to background any expensive download operations.
|
||||
@result An opaque identifier to be used in canceling the download, via `cancelImageDownloadForIdentifier:`. You must
|
||||
retain the identifier if you wish to use it later.
|
||||
|
||||
@ -50,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN
|
||||
*
|
||||
* @param contentView UIView to add a (sized) node's view to.
|
||||
*
|
||||
* @param cellNode The cell node to be added.
|
||||
* @param node The cell node to be added.
|
||||
*/
|
||||
- (void)configureContentView:(UIView *)contentView forCellNode:(ASCellNode *)node;
|
||||
|
||||
|
||||
@ -158,7 +158,6 @@ extern NSInteger const ASDefaultTransactionPriority;
|
||||
/**
|
||||
@summary Adds a block to run on the completion of the async transaction.
|
||||
|
||||
@param queue The dispatch queue on which to execute the block.
|
||||
@param completion The completion block that will be executed with the output of the execution block when all of the
|
||||
operations in the transaction are completed. Executed and released on callbackQueue.
|
||||
*/
|
||||
|
||||
@ -81,7 +81,7 @@ typedef BOOL(^asdisplaynode_iscancelled_block_t)(void);
|
||||
/**
|
||||
@summary Delegate method to draw layer contents into a CGBitmapContext. The current UIGraphics context will be set to an appropriate context.
|
||||
@param parameters An object describing all of the properties you need to draw. Return this from -drawParametersForAsyncLayer:
|
||||
@param isCancelled Execute this block to check whether the current drawing operation has been cancelled to avoid unnecessary work. A return value of YES means cancel drawing and return.
|
||||
@param isCancelledBlock Execute this block to check whether the current drawing operation has been cancelled to avoid unnecessary work. A return value of YES means cancel drawing and return.
|
||||
@param isRasterizing YES if the layer is being rasterized into another layer, in which case drawRect: probably wants to avoid doing things like filling its bounds with a zero-alpha color to clear the backing store.
|
||||
*/
|
||||
+ (void)drawRect:(CGRect)bounds withParameters:(id<NSObject>)parameters isCancelled:(asdisplaynode_iscancelled_block_t)isCancelledBlock isRasterizing:(BOOL)isRasterizing;
|
||||
@ -89,7 +89,7 @@ typedef BOOL(^asdisplaynode_iscancelled_block_t)(void);
|
||||
/**
|
||||
@summary Delegate override to provide new layer contents as a UIImage.
|
||||
@param parameters An object describing all of the properties you need to draw. Return this from -drawParametersForAsyncLayer:
|
||||
@param isCancelled Execute this block to check whether the current drawing operation has been cancelled to avoid unnecessary work. A return value of YES means cancel drawing and return.
|
||||
@param isCancelledBlock Execute this block to check whether the current drawing operation has been cancelled to avoid unnecessary work. A return value of YES means cancel drawing and return.
|
||||
@return A UIImage with contents that are ready to display on the main thread. Make sure that the image is already decoded before returning it here.
|
||||
*/
|
||||
+ (UIImage *)displayWithParameters:(id<NSObject>)parameters isCancelled:(asdisplaynode_iscancelled_block_t)isCancelledBlock;
|
||||
|
||||
@ -42,7 +42,6 @@ ASDISPLAYNODE_INLINE CGSize ceilSizeValue(CGSize s)
|
||||
|
||||
/**
|
||||
@abstract Returns the bounding size for the text view's text.
|
||||
@param components The TextKit components to calculate the constrained size of the text for.
|
||||
@param constrainedWidth The constraining width to be used during text-sizing. Usually, this value should be the receiver's calculated size.
|
||||
@result A CGSize representing the bounding size for the receiver's text.
|
||||
*/
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
/**
|
||||
@abstract Correctly equates two objects, including cases where both objects are nil. The latter is a case where `isEqual:` fails.
|
||||
@param obj The first object in the comparison. Can be nil.
|
||||
@param obj The second object in the comparison. Can be nil.
|
||||
@param otherObj The second object in the comparison. Can be nil.
|
||||
@result YES if the objects are equal, including cases where both object are nil.
|
||||
*/
|
||||
ASDISPLAYNODE_INLINE BOOL ASObjectIsEqual(id<NSObject> obj, id<NSObject> otherObj)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user