diff --git a/AsyncDisplayKit/ASCollectionNode.h b/AsyncDisplayKit/ASCollectionNode.h index a014b26efb..f8d644f7a6 100644 --- a/AsyncDisplayKit/ASCollectionNode.h +++ b/AsyncDisplayKit/ASCollectionNode.h @@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in full mode. + * @return A tuning parameter value for the given range type in full mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType @@ -65,7 +65,7 @@ NS_ASSUME_NONNULL_BEGIN * @param rangeMode The range mode to get the running parameters for. * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in the given mode. + * @return A tuning parameter value for the given range type in the given mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType diff --git a/AsyncDisplayKit/ASCollectionView.h b/AsyncDisplayKit/ASCollectionView.h index fa38675c5d..7f363e6d11 100644 --- a/AsyncDisplayKit/ASCollectionView.h +++ b/AsyncDisplayKit/ASCollectionView.h @@ -56,7 +56,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in full mode. + * @return A tuning parameter value for the given range type in full mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType @@ -80,7 +80,7 @@ NS_ASSUME_NONNULL_BEGIN * @param rangeMode The range mode to get the running parameters for. * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in the given mode. + * @return A tuning parameter value for the given range type in the given mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType @@ -277,7 +277,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a node for display at this indexpath or nil + * @return a node for display at this indexpath or nil */ - (nullable ASCellNode *)nodeForItemAtIndexPath:(NSIndexPath *)indexPath; @@ -288,7 +288,7 @@ NS_ASSUME_NONNULL_BEGIN * @param elementKind The kind of supplementary node to locate. * @param indexPath The index path of the requested supplementary node. * - * @returns The specified supplementary node or nil + * @return The specified supplementary node or nil */ - (nullable ASCellNode *)supplementaryNodeForElementKind:(NSString *)elementKind atIndexPath:(NSIndexPath *)indexPath; @@ -297,14 +297,14 @@ NS_ASSUME_NONNULL_BEGIN * * @param cellNode a cellNode part of the table view * - * @returns an indexPath for this cellNode + * @return an indexPath for this cellNode */ - (NSIndexPath *)indexPathForNode:(ASCellNode *)cellNode; /** * Similar to -visibleCells. * - * @returns an array containing the nodes being displayed on screen. + * @return an array containing the nodes being displayed on screen. */ - (NSArray *)visibleNodes; @@ -318,14 +318,14 @@ NS_ASSUME_NONNULL_BEGIN /** * Determines collection view's current scroll direction. Supports 2-axis collection views. * - * @returns a bitmask of ASScrollDirection values. + * @return a bitmask of ASScrollDirection values. */ - (ASScrollDirection)scrollDirection; /** * Determines collection view's scrollable directions. * - * @returns a bitmask of ASScrollDirection values. + * @return a bitmask of ASScrollDirection values. */ - (ASScrollDirection)scrollableDirections; @@ -371,7 +371,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a node for display at this indexpath. This will be called on the main thread and should + * @return a node for display at this indexpath. This will be called on the main thread and should * not implement reuse (it will be called once per row). Unlike UICollectionView's version, * this method is not called when the row is about to display. */ @@ -385,7 +385,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a block that creates the node for display at this indexpath. + * @return a block that creates the node for display at this indexpath. * Must be thread-safe (can be called on the main thread or a background * queue) and should not implement reuse (it will be called once per row). */ @@ -438,7 +438,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the node. * - * @returns A constrained size range for layout the node at this index path. + * @return A constrained size range for layout the node at this index path. */ - (ASSizeRange)collectionView:(ASCollectionView *)collectionView constrainedSizeForNodeAtIndexPath:(NSIndexPath *)indexPath; diff --git a/AsyncDisplayKit/ASEditableTextNode.h b/AsyncDisplayKit/ASEditableTextNode.h index 3274bb94ce..9d45bf95dc 100644 --- a/AsyncDisplayKit/ASEditableTextNode.h +++ b/AsyncDisplayKit/ASEditableTextNode.h @@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN /** * @abstract Initializes an editable text node using default TextKit components. * - * @returns An initialized ASEditableTextNode. + * @return An initialized ASEditableTextNode. */ - (instancetype)init; @@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN * @param textKitComponents The TextKit stack used to render text. * @param placeholderTextKitComponents The TextKit stack used to render placeholder text. * - * @returns An initialized ASEditableTextNode. + * @return An initialized ASEditableTextNode. */ - (instancetype)initWithTextKitComponents:(ASTextKitComponents *)textKitComponents placeholderTextKitComponents:(ASTextKitComponents *)placeholderTextKitComponents; diff --git a/AsyncDisplayKit/ASImageNode.h b/AsyncDisplayKit/ASImageNode.h index 2bba89d709..4c7d1c4f8c 100644 --- a/AsyncDisplayKit/ASImageNode.h +++ b/AsyncDisplayKit/ASImageNode.h @@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param image The image to be displayed. * - * @returns A transformed image. + * @return A transformed image. */ typedef UIImage * _Nullable (^asimagenode_modification_block_t)(UIImage *image); @@ -181,7 +181,7 @@ ASDISPLAYNODE_EXTERN_C_BEGIN * * @see * - * @returns An ASImageNode image modification block. + * @return An ASImageNode image modification block. */ asimagenode_modification_block_t ASImageNodeRoundBorderModificationBlock(CGFloat borderWidth, UIColor * _Nullable borderColor); @@ -193,7 +193,7 @@ asimagenode_modification_block_t ASImageNodeRoundBorderModificationBlock(CGFloat * * @see * - * @returns An ASImageNode image modification block. + * @return An ASImageNode image modification block. */ asimagenode_modification_block_t ASImageNodeTintColorModificationBlock(UIColor *color); diff --git a/AsyncDisplayKit/ASMultiplexImageNode.h b/AsyncDisplayKit/ASMultiplexImageNode.h index 8e14b2807e..cc571ab494 100644 --- a/AsyncDisplayKit/ASMultiplexImageNode.h +++ b/AsyncDisplayKit/ASMultiplexImageNode.h @@ -66,7 +66,7 @@ typedef NS_ENUM(NSUInteger, ASMultiplexImageNodeErrorCode) { * @param cache The object that implements a cache of images for the image node. * @param downloader The object that implements image downloading for the image node. * @discussion If `cache` is nil, the receiver will not attempt to retrieve images from a cache before downloading them. - * @returns An initialized ASMultiplexImageNode. + * @return An initialized ASMultiplexImageNode. */ - (instancetype)initWithCache:(nullable id)cache downloader:(nullable id)downloader NS_DESIGNATED_INITIALIZER; @@ -223,7 +223,7 @@ didFinishDownloadingImageWithIdentifier:(ASImageIdentifier)imageIdentifier * @param imageIdentifier The identifier for the image that should be returned. * @discussion If the image is already available to the data source, this method should be used in lieu of providing the * URL to the image via -multiplexImageNode:URLForImageIdentifier:. - * @returns A UIImage corresponding to `imageIdentifier`, or nil if none is available. + * @return A UIImage corresponding to `imageIdentifier`, or nil if none is available. */ - (nullable UIImage *)multiplexImageNode:(ASMultiplexImageNode *)imageNode imageForImageIdentifier:(ASImageIdentifier)imageIdentifier; diff --git a/AsyncDisplayKit/ASNetworkImageNode.h b/AsyncDisplayKit/ASNetworkImageNode.h index c0d2a3e6d9..dddc0c426c 100644 --- a/AsyncDisplayKit/ASNetworkImageNode.h +++ b/AsyncDisplayKit/ASNetworkImageNode.h @@ -33,14 +33,14 @@ NS_ASSUME_NONNULL_BEGIN * * @discussion If `cache` is nil, the receiver will not attempt to retrieve images from a cache before downloading them. * - * @returns An initialized ASNetworkImageNode. + * @return An initialized ASNetworkImageNode. */ - (instancetype)initWithCache:(nullable id)cache downloader:(id)downloader NS_DESIGNATED_INITIALIZER; /** * Convenience initialiser. * - * @returns An ASNetworkImageNode configured to use the NSURLSession-powered ASBasicImageDownloader, and no extra cache. + * @return An ASNetworkImageNode configured to use the NSURLSession-powered ASBasicImageDownloader, and no extra cache. */ - (instancetype)init; diff --git a/AsyncDisplayKit/ASPagerNode.h b/AsyncDisplayKit/ASPagerNode.h index 5ca8f79674..0ab55a0c7d 100644 --- a/AsyncDisplayKit/ASPagerNode.h +++ b/AsyncDisplayKit/ASPagerNode.h @@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN * This method replaces -collectionView:numberOfItemsInSection: * * @param pagerNode The sender. - * @returns The total number of pages that can display in the pagerNode. + * @return The total number of pages that can display in the pagerNode. */ - (NSInteger)numberOfPagesInPagerNode:(ASPagerNode *)pagerNode; @@ -36,7 +36,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param pagerNode The sender. * @param index The index of the requested node. - * @returns a node for display at this index. This will be called on the main thread and should + * @return a node for display at this index. This will be called on the main thread and should * not implement reuse (it will be called once per row). Unlike UICollectionView's version, * this method is not called when the row is about to display. */ @@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param pagerNode The sender. * @param index The index of the requested node. - * @returns a block that creates the node for display at this index. + * @return a block that creates the node for display at this index. * Must be thread-safe (can be called on the main thread or a background * queue) and should not implement reuse (it will be called once per row). */ @@ -65,7 +65,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param pagerNode The sender. * @param index The index of the node. - * @returns A constrained size range for layout the node at this index. + * @return A constrained size range for layout the node at this index. */ - (ASSizeRange)pagerNode:(ASPagerNode *)pagerNode constrainedSizeForNodeAtIndex:(NSInteger)index; diff --git a/AsyncDisplayKit/ASTableView.h b/AsyncDisplayKit/ASTableView.h index a8ff3c6be1..b48bccf59d 100644 --- a/AsyncDisplayKit/ASTableView.h +++ b/AsyncDisplayKit/ASTableView.h @@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in full mode. + * @return A tuning parameter value for the given range type in full mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType @@ -76,7 +76,7 @@ NS_ASSUME_NONNULL_BEGIN * @param rangeMode The range mode to get the running parameters for. * @param rangeType The range type to get the tuning parameters for. * - * @returns A tuning parameter value for the given range type in the given mode. + * @return A tuning parameter value for the given range type in the given mode. * * @see ASLayoutRangeMode * @see ASLayoutRangeType @@ -267,7 +267,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a node for display at this indexpath. + * @return a node for display at this indexpath. */ - (ASCellNode *)nodeForRowAtIndexPath:(NSIndexPath *)indexPath; @@ -276,14 +276,14 @@ NS_ASSUME_NONNULL_BEGIN * * @param cellNode a cellNode part of the table view * - * @returns an indexPath for this cellNode + * @return an indexPath for this cellNode */ - (nullable NSIndexPath *)indexPathForNode:(ASCellNode *)cellNode; /** * Similar to -visibleCells. * - * @returns an array containing the cell nodes being displayed on screen. + * @return an array containing the cell nodes being displayed on screen. */ - (NSArray *)visibleNodes; @@ -327,7 +327,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a node for display at this indexpath. This will be called on the main thread and should not implement reuse (it will be called once per row). Unlike UITableView's version, this method + * @return a node for display at this indexpath. This will be called on the main thread and should not implement reuse (it will be called once per row). Unlike UITableView's version, this method * is not called when the row is about to display. */ - (ASCellNode *)tableView:(ASTableView *)tableView nodeForRowAtIndexPath:(NSIndexPath *)indexPath; @@ -340,7 +340,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the requested node. * - * @returns a block that creates the node for display at this indexpath. + * @return a block that creates the node for display at this indexpath. * Must be thread-safe (can be called on the main thread or a background * queue) and should not implement reuse (it will be called once per row). */ @@ -446,7 +446,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param indexPath The index path of the node. * - * @returns A constrained size range for layout the node at this index path. + * @return A constrained size range for layout the node at this index path. */ - (ASSizeRange)tableView:(ASTableView *)tableView constrainedSizeForRowAtIndexPath:(NSIndexPath *)indexPath; diff --git a/AsyncDisplayKit/Details/ASBatchContext.h b/AsyncDisplayKit/Details/ASBatchContext.h index 2795219643..4e281a0277 100644 --- a/AsyncDisplayKit/Details/ASBatchContext.h +++ b/AsyncDisplayKit/Details/ASBatchContext.h @@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN /** * Retrieve the state of the current batch process. * - * @returns A boolean reflecting if the owner of the context object is fetching another batch. + * @return A boolean reflecting if the owner of the context object is fetching another batch. */ - (BOOL)isFetching; @@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN * @discussion If an error occurs in the context owner, the batch fetching may become out of sync and need to be * cancelled. For best practices, pass the return value of -batchWasCancelled to -completeBatchFetch:. * - * @returns A boolean reflecting if the context object owner had to cancel the batch process. + * @return A boolean reflecting if the context object owner had to cancel the batch process. */ - (BOOL)batchFetchingWasCancelled; diff --git a/AsyncDisplayKit/Details/ASRangeController.h b/AsyncDisplayKit/Details/ASRangeController.h index c46b1d99b5..dc312e0286 100644 --- a/AsyncDisplayKit/Details/ASRangeController.h +++ b/AsyncDisplayKit/Details/ASRangeController.h @@ -103,28 +103,28 @@ NS_ASSUME_NONNULL_BEGIN /** * @param rangeController Sender. * - * @returns an array of index paths corresponding to the nodes currently visible onscreen (i.e., the visible range). + * @return an array of index paths corresponding to the nodes currently visible onscreen (i.e., the visible range). */ - (NSArray *)visibleNodeIndexPathsForRangeController:(ASRangeController *)rangeController; /** * @param rangeController Sender. * - * @returns the current scroll direction of the view using this range controller. + * @return the current scroll direction of the view using this range controller. */ - (ASScrollDirection)scrollDirectionForRangeController:(ASRangeController *)rangeController; /** * @param rangeController Sender. * - * @returns the receiver's viewport size (i.e., the screen space occupied by the visible range). + * @return the receiver's viewport size (i.e., the screen space occupied by the visible range). */ - (CGSize)viewportSizeForRangeController:(ASRangeController *)rangeController; /** * @param rangeController Sender. * - * @returns the ASInterfaceState of the node that this controller is powering. This allows nested range controllers + * @return the ASInterfaceState of the node that this controller is powering. This allows nested range controllers * to collaborate with one another, as an outer controller may set bits in .interfaceState such as Visible. * If this controller is an orthogonally scrolling element, it waits until it is visible to preload outside the viewport. */ diff --git a/AsyncDisplayKit/Private/_ASHierarchyChangeSet.h b/AsyncDisplayKit/Private/_ASHierarchyChangeSet.h index 437633dadd..b53f7296e2 100644 --- a/AsyncDisplayKit/Private/_ASHierarchyChangeSet.h +++ b/AsyncDisplayKit/Private/_ASHierarchyChangeSet.h @@ -123,7 +123,7 @@ NSString *NSStringFromASHierarchyChangeType(_ASHierarchyChangeType changeType); Get the section index after the update for the given section before the update. @precondition The change set must be completed. - @returns The new section index, or NSNotFound if the given section was deleted. + @return The new section index, or NSNotFound if the given section was deleted. */ - (NSUInteger)newSectionForOldSection:(NSUInteger)oldSection;