Merge pull request facebookarchive#1340 from ejensen/documentation-corrections

appleguy · appleguy · commit de4e4db671b9 · 2016-03-09T02:52:48.000-08:00
[Documentation] Various header documentation corrections and refinements.
diff --git a/AsyncDisplayKit/ASButtonNode.h b/AsyncDisplayKit/ASButtonNode.h
@@ -38,9 +38,7 @@
 @property (nonatomic, assign) ASVerticalAlignment contentVerticalAlignment;
 
 /**
- * @discussion insets the title and the image node
- * 
- * @param contentEdgeInsets The insets used around the title and image node
+ * @discussion The insets used around the title and image node
  */
 @property (nonatomic, assign) UIEdgeInsets contentEdgeInsets;
 
diff --git a/AsyncDisplayKit/ASCollectionView.h b/AsyncDisplayKit/ASCollectionView.h
@@ -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:`
diff --git a/AsyncDisplayKit/ASCollectionViewLayoutFacilitatorProtocol.h b/AsyncDisplayKit/ASCollectionViewLayoutFacilitatorProtocol.h
@@ -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;
 
diff --git a/AsyncDisplayKit/ASControlNode.h b/AsyncDisplayKit/ASControlNode.h
@@ -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
diff --git a/AsyncDisplayKit/ASImageNode.h b/AsyncDisplayKit/ASImageNode.h
@@ -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>
  *
diff --git a/AsyncDisplayKit/ASMultiplexImageNode.mm b/AsyncDisplayKit/ASMultiplexImageNode.mm
@@ -124,7 +124,7 @@ - (void)_loadNextImage;
   @param imageIdentifier The identifier for the image to be fetched. May not be nil.
   @param imageURL The URL of the image to fetch. May not be nil.
   @param completionBlock The block to be performed when the image has been fetched from the cache, if possible. May not be nil.
-    @param image The image fetched from the cache, if any.
+  @param image The image fetched from the cache, if any.
   @discussion This method queries both the session's in-memory and on-disk caches (with preference for the in-memory cache).
  */
 - (void)_fetchImageWithIdentifierFromCache:(id)imageIdentifier URL:(NSURL *)imageURL completion:(void (^)(UIImage *image))completionBlock;
@@ -135,8 +135,8 @@ - (void)_fetchImageWithIdentifierFromCache:(id)imageIdentifier URL:(NSURL *)imag
   @param imageIdentifier The identifier for the image to be loaded. May not be nil.
   @param assetURL The assets-library URL (e.g., "assets-library://identifier") of the image to load, from ALAsset. May not be nil.
   @param completionBlock The block to be performed when the image has been loaded, if possible. May not be nil.
-    @param image The image that was loaded. May be nil if no image could be downloaded.
-    @param error An error describing why the load failed, if it failed; nil otherwise.
+  @param image The image that was loaded. May be nil if no image could be downloaded.
+  @param error An error describing why the load failed, if it failed; nil otherwise.
  */
 - (void)_loadALAssetWithIdentifier:(id)imageIdentifier URL:(NSURL *)assetURL completion:(void (^)(UIImage *image, NSError *error))completionBlock;
 
@@ -145,8 +145,8 @@ - (void)_loadALAssetWithIdentifier:(id)imageIdentifier URL:(NSURL *)assetURL com
   @param imageIdentifier The identifier for the image to be loaded. May not be nil.
   @param request The photos image request to load. May not be nil.
   @param completionBlock The block to be performed when the image has been loaded, if possible. May not be nil.
-    @param image The image that was loaded. May be nil if no image could be downloaded.
-    @param error An error describing why the load failed, if it failed; nil otherwise.
+  @param image The image that was loaded. May be nil if no image could be downloaded.
+  @param error An error describing why the load failed, if it failed; nil otherwise.
  */
 - (void)_loadPHAssetWithRequest:(ASPhotosFrameworkImageRequest *)request identifier:(id)imageIdentifier completion:(void (^)(UIImage *image, NSError *error))completionBlock;
 #endif
@@ -155,8 +155,8 @@ - (void)_loadPHAssetWithRequest:(ASPhotosFrameworkImageRequest *)request identif
  @param imageIdentifier The identifier for the image to be downloaded. May not be nil.
  @param imageURL The URL of the image to downloaded. May not be nil.
  @param completionBlock The block to be performed when the image has been downloaded, if possible. May not be nil.
-   @param image The image that was downloaded. May be nil if no image could be downloaded.
-   @param error An error describing why the download failed, if it failed; nil otherwise.
+ @param image The image that was downloaded. May be nil if no image could be downloaded.
+ @param error An error describing why the download failed, if it failed; nil otherwise.
  */
 - (void)_downloadImageWithIdentifier:(id)imageIdentifier URL:(NSURL *)imageURL completion:(void (^)(UIImage *image, NSError *error))completionBlock;
 
@@ -737,10 +737,13 @@ - (void)_fetchImageWithIdentifierFromCache:(id)imageIdentifier URL:(NSURL *)imag
         completionBlock(imageFromCache);
       }];
     } else {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
       [_cache fetchCachedImageWithURL:imageURL callbackQueue:dispatch_get_main_queue() completion:^(CGImageRef coreGraphicsImageFromCache) {
         UIImage *imageFromCache = (coreGraphicsImageFromCache ? [UIImage imageWithCGImage:coreGraphicsImageFromCache] : nil);
         completionBlock(imageFromCache);
       }];
+#pragma clang diagnostic pop
     }
   }
   // If we don't have a cache, just fail immediately.
@@ -795,6 +798,8 @@ - (void)_downloadImageWithIdentifier:(id)imageIdentifier URL:(NSURL *)imageURL c
                                                               [strongSelf->_delegate multiplexImageNode:weakSelf didFinishDownloadingImageWithIdentifier:imageIdentifier error:error];
                                                           }]];
     } else {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
       [self _setDownloadIdentifier:[_downloader downloadImageWithURL:imageURL
                                                        callbackQueue:dispatch_get_main_queue()
                                                downloadProgressBlock:downloadProgressBlock
@@ -811,6 +816,7 @@ - (void)_downloadImageWithIdentifier:(id)imageIdentifier URL:(NSURL *)imageURL c
                                                             if (strongSelf->_delegateFlags.downloadFinish)
                                                               [strongSelf->_delegate multiplexImageNode:weakSelf didFinishDownloadingImageWithIdentifier:imageIdentifier error:error];
                                                           }]];
+#pragma clang diagnostic pop
     }
   });
 }
diff --git a/AsyncDisplayKit/ASNetworkImageNode.mm b/AsyncDisplayKit/ASNetworkImageNode.mm
@@ -295,6 +295,8 @@ - (void)_downloadImageWithCompletion:(void (^)(UIImage *image, NSError*, id down
                                                      }
                                                    }];
     } else {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
       _downloadIdentifier = [_downloader downloadImageWithURL:_URL
                                                 callbackQueue:dispatch_get_main_queue()
                                         downloadProgressBlock:NULL
@@ -303,6 +305,7 @@ - (void)_downloadImageWithCompletion:(void (^)(UIImage *image, NSError*, id down
                                                        finished([UIImage imageWithCGImage:responseImage], error, nil);
                                                      }
                                                    }];
+#pragma clang diagnostic pop
     }
   });
 }
@@ -401,11 +404,14 @@ - (void)_lazilyLoadImageIfNecessary
                        callbackQueue:dispatch_get_main_queue()
                           completion:cacheCompletion];
         } else {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
           [_cache fetchCachedImageWithURL:_URL
                             callbackQueue:dispatch_get_main_queue()
                                completion:^(CGImageRef image) {
                                  cacheCompletion([UIImage imageWithCGImage:image]);
                                }];
+#pragma clang diagnostic pop
         }
       } else {
         [self _downloadImageWithCompletion:finished];
diff --git a/AsyncDisplayKit/ASPagerNode.h b/AsyncDisplayKit/ASPagerNode.h
@@ -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.
  *
diff --git a/AsyncDisplayKit/ASTableViewInternal.h b/AsyncDisplayKit/ASTableViewInternal.h
@@ -26,7 +26,7 @@
  *
  * @param dataControllerClass A controller class injected to and used to create a data controller for the table view.
  *
- * @param asyncDataFetchingEnabled This option is reserved for future use, and currently a no-op.
+ * @param ownedByNode Indicates whether the tableView is owned by an ASTableNode.
  */
 - (instancetype)_initWithFrame:(CGRect)frame style:(UITableViewStyle)style dataControllerClass:(Class)dataControllerClass ownedByNode:(BOOL)ownedByNode;
 
diff --git a/AsyncDisplayKit/Details/ASImageProtocols.h b/AsyncDisplayKit/Details/ASImageProtocols.h
@@ -7,7 +7,7 @@
  */
 
 #import <UIKit/UIKit.h>
-#import <Foundation/Foundation.h>
+#import <AsyncDisplayKit/ASBaseDefines.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -115,7 +115,7 @@ withDownloadIdentifier:(id)downloadIdentifier;
 - (nullable id)downloadImageWithURL:(NSURL *)URL
                       callbackQueue:(nullable dispatch_queue_t)callbackQueue
               downloadProgressBlock:(void (^ _Nullable)(CGFloat progress))downloadProgressBlock
-                         completion:(void (^ _Nullable)(CGImageRef _Nullable image, NSError * _Nullable error))completion;
+                         completion:(void (^ _Nullable)(CGImageRef _Nullable image, NSError * _Nullable error))completion ASDISPLAYNODE_DEPRECATED;
 
 @end
 
@@ -127,7 +127,7 @@ withDownloadIdentifier:(id)downloadIdentifier;
  */
 - (void)fetchCachedImageWithURL:(nullable NSURL *)URL
                   callbackQueue:(nullable dispatch_queue_t)callbackQueue
-                     completion:(void (^)(CGImageRef _Nullable imageFromCache))completion;
+                     completion:(void (^)(CGImageRef _Nullable imageFromCache))completion ASDISPLAYNODE_DEPRECATED;
 
 @end
 
diff --git a/AsyncDisplayKit/Details/ASRangeController.h b/AsyncDisplayKit/Details/ASRangeController.h
@@ -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;
 
diff --git a/AsyncDisplayKit/Details/Transactions/_ASAsyncTransaction.h b/AsyncDisplayKit/Details/Transactions/_ASAsyncTransaction.h
@@ -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.
  */
diff --git a/AsyncDisplayKit/Details/_ASDisplayLayer.h b/AsyncDisplayKit/Details/_ASDisplayLayer.h
@@ -81,15 +81,15 @@ 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;
 
 /**
  @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;
diff --git a/AsyncDisplayKit/TextKit/ASTextKitHelpers.h b/AsyncDisplayKit/TextKit/ASTextKitHelpers.h
@@ -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.
  */
diff --git a/AsyncDisplayKitTests/ASBasicImageDownloaderTests.m b/AsyncDisplayKitTests/ASBasicImageDownloaderTests.m
@@ -22,7 +22,10 @@ - (void)testAsynchronouslyDownloadTheSameURLTwice
     ASBasicImageDownloader *downloader = [ASBasicImageDownloader sharedImageDownloader];
     
     NSURL *URL = [NSURL URLWithString:@"http://wrongPath/wrongResource.png"];
-  
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
     __block BOOL firstDone = NO;
     
     [downloader downloadImageWithURL:URL
@@ -40,7 +43,9 @@ - (void)testAsynchronouslyDownloadTheSameURLTwice
                           completion:^(CGImageRef image, NSError *error) {
                               secondDone = YES;
                           }];
-  
+
+#pragma clang diagnostic pop
+
     sleep(3);
     XCTAssert(firstDone && secondDone, @"Not all ASBasicImageDownloader completion handlers have been called after 3 seconds");
 }
diff --git a/Base/ASEqualityHelpers.h b/Base/ASEqualityHelpers.h
@@ -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)

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ NS_ASSUME_NONNULL_BEGIN`
`173`	`173`	`/**`
`174`	`174`	`* Registers the given kind of supplementary node for use in creating node-backed supplementary views.`
`175`	`175`	`*`
`176`		`- * @param kind The kind of supplementary node that will be requested through the data source.`
	`176`	`+ * @param elementKind The kind of supplementary node that will be requested through the data source.`
`177`	`177`	`*`
`178`	`178`	`* @discussion Use this method to register support for the use of supplementary nodes in place of the default`
`179`	`179`	* `registerClass:forSupplementaryViewOfKind:withReuseIdentifier:` and `registerNib:forSupplementaryViewOfKind:withReuseIdentifier:`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@`
`18`	`18`	`/**`
`19`	`19`	`* Inform that the collectionView is editing the cells at a list of indexPaths`
`20`	`20`	`*`
`21`		`- * @param indexPaths, an array of NSIndexPath objects of cells being/will be edited.`
`22`		`- * @param isBatched, indicates whether the editing operation will be batched by the collectionView`
	`21`	`+ * @param indexPaths an array of NSIndexPath objects of cells being/will be edited.`
	`22`	`+ * @param isBatched indicates whether the editing operation will be batched by the collectionView`
`23`	`23`	`*`
`24`	`24`	`* NOTE: when isBatched, used in combination with -collectionViewWillPerformBatchUpdates`
`25`	`25`	`*/`
`@@ -28,10 +28,10 @@`
`28`	`28`	`/**`
`29`	`29`	`* Inform that the collectionView is editing the sections at a set of indexes`
`30`	`30`	`*`
`31`		`- * @param indexes, an NSIndexSet of section indexes being/will be edited.`
`32`		`- * @param isBatched, indicates whether the editing operation will be batched by the collectionView`
	`31`	`+ * @param indexes an NSIndexSet of section indexes being/will be edited.`
	`32`	`+ * @param batched indicates whether the editing operation will be batched by the collectionView`
`33`	`33`	`*`
`34`		`- * NOTE: when isBatched, used in combination with -collectionViewWillPerformBatchUpdates`
	`34`	`+ * NOTE: when batched, used in combination with -collectionViewWillPerformBatchUpdates`
`35`	`35`	`*/`
`36`	`36`	`- (void)collectionViewWillEditSectionsAtIndexSet:(NSIndexSet *)indexes batched:(BOOL)batched;`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ asimagenode_modification_block_t ASImageNodeRoundBorderModificationBlock(CGFloat`
`131`	`131`	`* @abstract Image modification block that applies a tint color à la UIImage configured with`
`132`	`132`	`* renderingMode set to UIImageRenderingModeAlwaysTemplate.`
`133`	`133`	`*`
`134`		`- * @param tintColor The color to tint the image.`
	`134`	`+ * @param color The color to tint the image.`
`135`	`135`	`*`
`136`	`136`	`* @see <imageModificationBlock>`
`137`	`137`	`*`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`/**`
`56`	`56`	`* Provides the constrained size range for measuring the node at the index path.`
`57`	`57`	`*`
`58`		`- * @param collectionView The sender.`
	`58`	`+ * @param pagerNode The sender.`
`59`	`59`	`*`
`60`	`60`	`* @param indexPath The index path of the node.`
`61`	`61`	`*`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`*`
`27`	`27`	`* @param dataControllerClass A controller class injected to and used to create a data controller for the table view.`
`28`	`28`	`*`
`29`		`- * @param asyncDataFetchingEnabled This option is reserved for future use, and currently a no-op.`
	`29`	`+ * @param ownedByNode Indicates whether the tableView is owned by an ASTableNode.`
`30`	`30`	`*/`
`31`	`31`	`- (instancetype)_initWithFrame:(CGRect)frame style:(UITableViewStyle)style dataControllerClass:(Class)dataControllerClass ownedByNode:(BOOL)ownedByNode;`
`32`	`32`