add the enum direct comments back (#2936)

This commit is contained in:
Hannah Troisi
2017-01-26 16:39:54 -08:00
committed by Adlai Holler
parent e143942d22
commit 7d68ce33bb
4 changed files with 35 additions and 8 deletions

View File

@@ -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 */

View File

@@ -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. */

View File

@@ -10,7 +10,12 @@
#import <AsyncDisplayKit/ASRelativeLayoutSpec.h>
/** 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,

View File

@@ -12,7 +12,12 @@
#import <AsyncDisplayKit/ASLayoutSpec.h>
/** 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,