[ASImageNode] More refined naming and documentation for [ASImageNode shouldShowImageScalingOverlay]

This commit is contained in:
Hannah Troisi
2016-03-08 23:30:17 -08:00
parent 3fe44b4e23
commit 51eccb3d96
3 changed files with 16 additions and 19 deletions

View File

@@ -9,13 +9,15 @@
#import <Foundation/Foundation.h>
#import "ASImageNode.h"
@interface ASImageNode (Debug)
@interface ASImageNode (Debugging)
/**
* Class method to enable visualization of an ASImageNode's image size. For app debugging purposes only.
* @param enabled Specify YES to turn on this debug feature when messaging the ASImageNode class.
* Enables an ASImageNode debug label that shows the ratio of pixels in the source image to those in
* the displayed bounds (including cropRect). This helps detect excessive image fetching / downscaling,
* as well as upscaling (such as providing a URL not suitable for a Retina device). For dev purposes only.
* @param enabled Specify YES to show the label on all ASImageNodes with non-1.0x source-to-bounds pixel ratio.
*/
+ (void)setImageDebugEnabled:(BOOL)enable;
+ (BOOL)shouldShowImageDebugOverlay;
+ (void)setShouldShowImageScalingOverlay:(BOOL)show;
+ (BOOL)shouldShowImageScalingOverlay;
@end