diff --git a/AsyncDisplayKit/ASDisplayNode.h b/AsyncDisplayKit/ASDisplayNode.h index 2b344e7304..42354b3111 100644 --- a/AsyncDisplayKit/ASDisplayNode.h +++ b/AsyncDisplayKit/ASDisplayNode.h @@ -137,7 +137,7 @@ * @warning Subclasses must not override this; it caches results from -calculateSizeThatFits:. Calling this method may * be expensive if result is not cached. * - * @see calculateSizeThatFits: + * @see [ASDisplayNode(Subclassing) calculateSizeThatFits:] */ - (CGSize)measure:(CGSize)constrainedSize; @@ -310,8 +310,6 @@ * * If a setNeedsDisplay occurs while preventOrCancelDisplay is YES, and preventOrCancelDisplay is set to NO, then the * layer will be automatically displayed. - * - * @see displayWasCancelled */ @property (nonatomic, assign) BOOL preventOrCancelDisplay; @@ -433,7 +431,7 @@ * * After the view is created, the properties pass through to the view directly as if called on the main thread. * - * @see UIView and CALayer for documentation on these common properties. + * See UIView and CALayer for documentation on these common properties. */ @interface ASDisplayNode (UIViewBridge) diff --git a/AsyncDisplayKit/Details/ASRangeController.h b/AsyncDisplayKit/Details/ASRangeController.h index 9abb9b1ab5..4a5e1c6a6d 100644 --- a/AsyncDisplayKit/Details/ASRangeController.h +++ b/AsyncDisplayKit/Details/ASRangeController.h @@ -37,7 +37,7 @@ typedef struct { /** * Notify the receiver that the visible range has been updated. * - * @see -rangeControllerVisibleNodeIndexPaths: + * @see [ASRangeControllerDelegate rangeControllerVisibleNodeIndexPaths:] */ - (void)visibleNodeIndexPathsDidChange; diff --git a/AsyncDisplayKit/Details/ASTextNodeTextKitHelpers.h b/AsyncDisplayKit/Details/ASTextNodeTextKitHelpers.h index 0adb7b437d..0820315e1b 100644 --- a/AsyncDisplayKit/Details/ASTextNodeTextKitHelpers.h +++ b/AsyncDisplayKit/Details/ASTextNodeTextKitHelpers.h @@ -23,7 +23,7 @@ typedef struct { @abstract Creates the stack of TextKit components. @param attributedSeedString The attributed string to sed the returned text storage with, or nil to receive an blank text storage. @param textContainerSize The size of the text-container. Typically, size specifies the constraining width of the layout, and FLT_MAX for height. Pass CGSizeZero if these components will be hooked up to a UITextView, which will manage the text container's size itself. - @return A {@ref ASTextKitComponents} containing the created components. The text view component will be nil. + @return A `ASTextKitComponents` containing the created components. The text view component will be nil. @discussion The returned components will be hooked up together, so they are ready for use as a system upon return. */ extern ASTextKitComponents ASTextKitComponentsCreate(NSAttributedString *attributedSeedString, CGSize textContainerSize); diff --git a/AsyncDisplayKit/Private/ASImageProtocols.h b/AsyncDisplayKit/Private/ASImageProtocols.h index 1f55c928ca..efab16ffb0 100644 --- a/AsyncDisplayKit/Private/ASImageProtocols.h +++ b/AsyncDisplayKit/Private/ASImageProtocols.h @@ -15,10 +15,10 @@ /** @abstract Attempts to fetch an image with the given URL from the cache. @param URL The URL of the image to retrieve from the cache. - @param callbackQueue The queue to call {@ref completion} on. If this value is nil, @{ref completion} will be invoked on the main-queue. + @param callbackQueue The queue to call `completion` on. If this value is nil, @{ref completion} will be invoked on the main-queue. @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. - @discussion If {@ref URL} is nil, {@ref completion} will be invoked immediately with a nil image. + @discussion If `URL` is nil, `completion` will be invoked immediately with a nil image. */ - (void)fetchCachedImageWithURL:(NSURL *)URL callbackQueue:(dispatch_queue_t)callbackQueue @@ -32,14 +32,14 @@ /** @abstract Downloads an image with the given URL. @param URL The URL of the image to download. - @param callbackQueue The queue to call {@ref downloadProgressBlock} and {@ref completion} on. If this value is nil, both blocks will be invoked on the main-queue. - @param downloadProgressBlock The block to be invoked when the download of {@ref URL} progresses. + @param callbackQueue The queue to call `downloadProgressBlock` and `completion` on. If this value is nil, both blocks will be invoked on the main-queue. + @param downloadProgressBlock 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 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 {@ref URL} failed, if the download failed; nil otherwise. - @discussion If {@ref URL} is nil, {@ref completion} will be invoked immediately with a nil image and an error describing why the download failed. - @result An opaque identifier to be used in canceling the download, via {@ref cancelImageDownloadForIdentifier:}. You must retain the identifier if you wish to use it later. + @param error An error describing why the download of `URL` failed, if the download failed; nil otherwise. + @discussion If `URL` is nil, `completion` will be invoked immediately with a nil image and an error describing why the download failed. + @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. */ - (id)downloadImageWithURL:(NSURL *)URL callbackQueue:(dispatch_queue_t)callbackQueue @@ -48,8 +48,8 @@ /** @abstract Cancels an image download. - @param downloadIdentifier The opaque download identifier object returned from {@ref downloadImageWithURL:callbackQueue:downloadProgressBlock:completion:}. - @discussion This method has no effect if {@ref downloadIdentifier} is nil. + @param downloadIdentifier The opaque download identifier object returned from `downloadImageWithURL:callbackQueue:downloadProgressBlock:completion:`. + @discussion This method has no effect if `downloadIdentifier` is nil. */ - (void)cancelImageDownloadForIdentifier:(id)downloadIdentifier; diff --git a/docs/build.sh b/docs/build.sh index 82c973ce38..1252dd4e02 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -13,6 +13,7 @@ appledoc \ --exit-threshold 2 \ --no-repeat-first-par \ --no-merge-categories \ + --explicit-crossref \ --project-name AsyncDisplayKit \ --project-company Facebook \ --company-id "com.facebook" \