ThePain/Swiftgram
1
0
Fork 0
mirror of https://github.com/Swiftgram/Telegram-iOS.git synced 2025-12-23 14:45:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improving documentation based on feedback. Thanks @appleguy! (#2364)

Browse Source 
* Improving documentation based on feedback. Thanks @appleguy!

* :palm + forehead:
This commit is contained in:
Garrett Moon
2016-10-07 16:59:44 -07:00
committed by Adlai Holler
parent c72b2b212c
commit 4f3593b211
4 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
AsyncDisplayKit/ASNavigationController.h
View File

@@ -20,7 +20,9 @@ NS_ASSUME_NONNULL_BEGIN
* ASNavigationController * ASNavigationController
* *
* @discussion ASNavigationController is a drop in replacement for UINavigationController * @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 * @see ASManagesChildVisibilityDepth
*/ */

2
AsyncDisplayKit/ASTextNode.h
View File

@@ -81,7 +81,7 @@ typedef NS_ENUM(NSUInteger, ASTextNodeHighlightStyle) {
@property (nonatomic, readonly, assign) NSUInteger lineCount; @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 * @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 * assign an array of UIBezierPath objects to exclude text from one or more regions in

10
AsyncDisplayKit/ASVisibilityProtocols.h
View File

@@ -27,9 +27,13 @@ ASDISPLAYNODE_EXTERN_C_END
/** /**
* ASVisibilityDepth * ASVisibilityDepth
* *
* @discussion A protocol which when implemented represents the number of user actions required to * @discussion "Visibility Depth" represents the number of user actions required to make an ASDisplayNode or
* make an ASDisplayNode or ASViewController visible. Parent view controllers should also implement * ASViewController visibile. AsyncDisplayKit uses this information to intelligently manage memory and focus
* @c ASManagesChildVisibilityDepth * 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 * @see ASManagesChildVisibilityDepth
*/ */

5
AsyncDisplayKit/Details/ASPINRemoteImageDownloader.h
View File

@@ -31,9 +31,10 @@ NS_ASSUME_NONNULL_BEGIN
/** /**
* The shared instance of a @c PINRemoteImageManager used by all @c ASPINRemoteImageDownloaders * 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 * 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 * @return An instance of a @c PINRemoteImageManager
*/ */