diff --git a/AsyncDisplayKit/ASDisplayNode.h b/AsyncDisplayKit/ASDisplayNode.h index cf33654b37..01d737bd6f 100644 --- a/AsyncDisplayKit/ASDisplayNode.h +++ b/AsyncDisplayKit/ASDisplayNode.h @@ -56,11 +56,13 @@ typedef void (^ASDisplayNodeContextModifier)(CGContextRef context); typedef ASLayoutSpec * _Nonnull(^ASLayoutSpecBlock)(__kindof ASDisplayNode * _Nonnull node, ASSizeRange constrainedSize); /** - Interface state is available on ASDisplayNode and ASViewController, and - allows checking whether a node is in an interface situation where it is prudent to trigger certain - actions: measurement, data loading, display, and visibility (the latter for animations or other onscreen-only effects). + * Interface state is available on ASDisplayNode and ASViewController, and + * allows checking whether a node is in an interface situation where it is prudent to trigger certain + * actions: measurement, data loading, display, and visibility (the latter for animations or other onscreen-only effects). + * + * The defualt state, ASInterfaceStateNone, means that the element is not predicted to be onscreen soon and + * preloading should not be performed. Swift: use [] for the default behavior. */ - typedef NS_OPTIONS(NSUInteger, ASInterfaceState) { /** The element is not predicted to be onscreen soon and preloading should not be performed */ diff --git a/AsyncDisplayKit/ASMapNode.h b/AsyncDisplayKit/ASMapNode.h index 1d9b96c7be..0ab7010c7a 100644 --- a/AsyncDisplayKit/ASMapNode.h +++ b/AsyncDisplayKit/ASMapNode.h @@ -14,6 +14,11 @@ NS_ASSUME_NONNULL_BEGIN +/** + * Map Annotation options. + * The default behavior is to ignore the annotations' positions, use the region or options specified instead. + * Swift: to select the default behavior, use []. + */ typedef NS_OPTIONS(NSUInteger, ASMapNodeShowAnnotationsOptions) { /** The annotations' positions are ignored, use the region or options specified instead. */ diff --git a/AsyncDisplayKit/Layout/ASCenterLayoutSpec.h b/AsyncDisplayKit/Layout/ASCenterLayoutSpec.h index a1474c4840..4d995fcb8d 100644 --- a/AsyncDisplayKit/Layout/ASCenterLayoutSpec.h +++ b/AsyncDisplayKit/Layout/ASCenterLayoutSpec.h @@ -10,7 +10,12 @@ #import -/** How the child is centered within the spec. */ +/** + * How the child is centered within the spec. + * + * The default option will position the child at {0,0} relatively to the layout bound. + * Swift: use [] for the default behavior. + */ typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecCenteringOptions) { /** The child is positioned in {0,0} relatively to the layout bounds */ ASCenterLayoutSpecCenteringNone = 0, @@ -22,7 +27,12 @@ typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecCenteringOptions) { ASCenterLayoutSpecCenteringXY = ASCenterLayoutSpecCenteringX | ASCenterLayoutSpecCenteringY }; -/** How much space the spec will take up. */ +/** + * How much space the spec will take up. + * + * The default option will allow the spec to take up the maximum size possible. + * Swift: use [] for the default behavior. + */ typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecSizingOptions) { /** The spec will take up the maximum size possible */ ASCenterLayoutSpecSizingOptionDefault = ASRelativeLayoutSpecSizingOptionDefault, diff --git a/AsyncDisplayKit/Layout/ASRelativeLayoutSpec.h b/AsyncDisplayKit/Layout/ASRelativeLayoutSpec.h index 31e6350849..d91e603457 100644 --- a/AsyncDisplayKit/Layout/ASRelativeLayoutSpec.h +++ b/AsyncDisplayKit/Layout/ASRelativeLayoutSpec.h @@ -12,7 +12,12 @@ #import -/** How the child is positioned within the spec. */ +/** + * How the child is positioned within the spec. + * + * The default option will position the child at point 0. + * Swift: use [] for the default behavior. + */ typedef NS_ENUM(NSUInteger, ASRelativeLayoutSpecPosition) { /** The child is positioned at point 0 */ ASRelativeLayoutSpecPositionNone = 0, @@ -24,7 +29,12 @@ typedef NS_ENUM(NSUInteger, ASRelativeLayoutSpecPosition) { ASRelativeLayoutSpecPositionEnd = 3, }; -/** How much space the spec will take up. */ +/** + * How much space the spec will take up. + * + * The default option will allow the spec to take up the maximum size possible. + * Swift: use [] for the default behavior. + */ typedef NS_OPTIONS(NSUInteger, ASRelativeLayoutSpecSizingOption) { /** The spec will take up the maximum size possible */ ASRelativeLayoutSpecSizingOptionDefault,