[Documentation] Add docs for exclusionPaths (#2325)

* Add docs for exclusionPaths

* Clearer, less-infringy
This commit is contained in:
Garrett Moon
2016-10-05 17:32:44 -07:00
committed by appleguy
parent 409c14890d
commit f1bf9be4d8

View File

@@ -80,6 +80,14 @@ typedef NS_ENUM(NSUInteger, ASTextNodeHighlightStyle) {
*/
@property (nonatomic, readonly, assign) NSUInteger lineCount;
/**
* An array of path objects representing the regions where text is not 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
* the text node's bounds. You can use this property to have text wrap around images,
* shapes or other text like a fancy magazine.
*/
@property (nullable, nonatomic, strong) NSArray<UIBezierPath *> *exclusionPaths;
#pragma mark - Placeholders