From 4f3593b211375dc1d0fea3607a39c3804bfa1792 Mon Sep 17 00:00:00 2001 From: Garrett Moon Date: Fri, 7 Oct 2016 16:59:44 -0700 Subject: [PATCH] Improving documentation based on feedback. Thanks @appleguy! (#2364) * Improving documentation based on feedback. Thanks @appleguy! * :palm + forehead: --- AsyncDisplayKit/ASNavigationController.h | 4 +++- AsyncDisplayKit/ASTextNode.h | 2 +- AsyncDisplayKit/ASVisibilityProtocols.h | 10 +++++++--- AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h | 5 +++-- 4 files changed, 14 insertions(+), 7 deletions(-) diff --git a/AsyncDisplayKit/ASNavigationController.h b/AsyncDisplayKit/ASNavigationController.h index 2dd070c5bb..03f18d068f 100644 --- a/AsyncDisplayKit/ASNavigationController.h +++ b/AsyncDisplayKit/ASNavigationController.h @@ -20,7 +20,9 @@ NS_ASSUME_NONNULL_BEGIN * ASNavigationController * * @discussion ASNavigationController is a drop in replacement for UINavigationController - * which implements the memory efficiency improving @c ASManagesChildVisibilityDepth protocol. + * which improves memory efficiency by implementing the @c ASManagesChildVisibilityDepth protocol. + * You can use ASNavigationController with regular UIViewControllers, as well as ASViewControllers. + * It is safe to subclass or use even where AsyncDisplayKit is not adopted. * * @see ASManagesChildVisibilityDepth */ diff --git a/AsyncDisplayKit/ASTextNode.h b/AsyncDisplayKit/ASTextNode.h index b501673719..354039e238 100644 --- a/AsyncDisplayKit/ASTextNode.h +++ b/AsyncDisplayKit/ASTextNode.h @@ -81,7 +81,7 @@ typedef NS_ENUM(NSUInteger, ASTextNodeHighlightStyle) { @property (nonatomic, readonly, assign) NSUInteger lineCount; /** - * An array of path objects representing the regions where text is not displayed. + * An array of path objects representing the regions where text should not be displayed. * * @discussion The default value of this property is an empty array. You can * assign an array of UIBezierPath objects to exclude text from one or more regions in diff --git a/AsyncDisplayKit/ASVisibilityProtocols.h b/AsyncDisplayKit/ASVisibilityProtocols.h index e589040da9..2c098cec2d 100644 --- a/AsyncDisplayKit/ASVisibilityProtocols.h +++ b/AsyncDisplayKit/ASVisibilityProtocols.h @@ -27,9 +27,13 @@ ASDISPLAYNODE_EXTERN_C_END /** * ASVisibilityDepth * - * @discussion A protocol which when implemented represents the number of user actions required to - * make an ASDisplayNode or ASViewController visible. Parent view controllers should also implement - * @c ASManagesChildVisibilityDepth + * @discussion "Visibility Depth" represents the number of user actions required to make an ASDisplayNode or + * ASViewController visibile. AsyncDisplayKit uses this information to intelligently manage memory and focus + * resources where they are most visible to the user. + * + * The ASVisibilityDepth protocol describes how custom view controllers can integrate with this system. + * + * Parent view controllers should also implement @c ASManagesChildVisibilityDepth * * @see ASManagesChildVisibilityDepth */ diff --git a/AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h b/AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h index 4521e29b77..08a51f1293 100644 --- a/AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h +++ b/AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h @@ -31,9 +31,10 @@ NS_ASSUME_NONNULL_BEGIN /** * The shared instance of a @c PINRemoteImageManager used by all @c ASPINRemoteImageDownloaders * - * @discussion you can use this method to access the shared downloader. This is useful to share a cache + * @discussion you can use this method to access the shared manager. This is useful to share a cache * and resources if you need to download images outside of an @c ASNetworkImageNode or - * @c ASMultiplexImageNode + * @c ASMultiplexImageNode. It's also useful to access the memoryCache and diskCache to set limits + * or handle authentication challenges. * * @return An instance of a @c PINRemoteImageManager */