Skip to content

Commit 7d68ce3

Browse files
Hannah TroisiAdlai Holler
authored andcommitted
add the enum direct comments back (facebookarchive#2936)
1 parent e143942 commit 7d68ce3

File tree

4 files changed

+35
-8
lines changed

4 files changed

+35
-8
lines changed

AsyncDisplayKit/ASDisplayNode.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,13 @@ typedef void (^ASDisplayNodeContextModifier)(CGContextRef context);
5656
typedef ASLayoutSpec * _Nonnull(^ASLayoutSpecBlock)(__kindof ASDisplayNode * _Nonnull node, ASSizeRange constrainedSize);
5757

5858
/**
59-
Interface state is available on ASDisplayNode and ASViewController, and
60-
allows checking whether a node is in an interface situation where it is prudent to trigger certain
61-
actions: measurement, data loading, display, and visibility (the latter for animations or other onscreen-only effects).
59+
* Interface state is available on ASDisplayNode and ASViewController, and
60+
* allows checking whether a node is in an interface situation where it is prudent to trigger certain
61+
* actions: measurement, data loading, display, and visibility (the latter for animations or other onscreen-only effects).
62+
*
63+
* The defualt state, ASInterfaceStateNone, means that the element is not predicted to be onscreen soon and
64+
* preloading should not be performed. Swift: use [] for the default behavior.
6265
*/
63-
6466
typedef NS_OPTIONS(NSUInteger, ASInterfaceState)
6567
{
6668
/** The element is not predicted to be onscreen soon and preloading should not be performed */

AsyncDisplayKit/ASMapNode.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414

1515
NS_ASSUME_NONNULL_BEGIN
1616

17+
/**
18+
* Map Annotation options.
19+
* The default behavior is to ignore the annotations' positions, use the region or options specified instead.
20+
* Swift: to select the default behavior, use [].
21+
*/
1722
typedef NS_OPTIONS(NSUInteger, ASMapNodeShowAnnotationsOptions)
1823
{
1924
/** The annotations' positions are ignored, use the region or options specified instead. */

AsyncDisplayKit/Layout/ASCenterLayoutSpec.h

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@
1010

1111
#import <AsyncDisplayKit/ASRelativeLayoutSpec.h>
1212

13-
/** How the child is centered within the spec. */
13+
/**
14+
* How the child is centered within the spec.
15+
*
16+
* The default option will position the child at {0,0} relatively to the layout bound.
17+
* Swift: use [] for the default behavior.
18+
*/
1419
typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecCenteringOptions) {
1520
/** The child is positioned in {0,0} relatively to the layout bounds */
1621
ASCenterLayoutSpecCenteringNone = 0,
@@ -22,7 +27,12 @@ typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecCenteringOptions) {
2227
ASCenterLayoutSpecCenteringXY = ASCenterLayoutSpecCenteringX | ASCenterLayoutSpecCenteringY
2328
};
2429

25-
/** How much space the spec will take up. */
30+
/**
31+
* How much space the spec will take up.
32+
*
33+
* The default option will allow the spec to take up the maximum size possible.
34+
* Swift: use [] for the default behavior.
35+
*/
2636
typedef NS_OPTIONS(NSUInteger, ASCenterLayoutSpecSizingOptions) {
2737
/** The spec will take up the maximum size possible */
2838
ASCenterLayoutSpecSizingOptionDefault = ASRelativeLayoutSpecSizingOptionDefault,

AsyncDisplayKit/Layout/ASRelativeLayoutSpec.h

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@
1212

1313
#import <AsyncDisplayKit/ASLayoutSpec.h>
1414

15-
/** How the child is positioned within the spec. */
15+
/**
16+
* How the child is positioned within the spec.
17+
*
18+
* The default option will position the child at point 0.
19+
* Swift: use [] for the default behavior.
20+
*/
1621
typedef NS_ENUM(NSUInteger, ASRelativeLayoutSpecPosition) {
1722
/** The child is positioned at point 0 */
1823
ASRelativeLayoutSpecPositionNone = 0,
@@ -24,7 +29,12 @@ typedef NS_ENUM(NSUInteger, ASRelativeLayoutSpecPosition) {
2429
ASRelativeLayoutSpecPositionEnd = 3,
2530
};
2631

27-
/** How much space the spec will take up. */
32+
/**
33+
* How much space the spec will take up.
34+
*
35+
* The default option will allow the spec to take up the maximum size possible.
36+
* Swift: use [] for the default behavior.
37+
*/
2838
typedef NS_OPTIONS(NSUInteger, ASRelativeLayoutSpecSizingOption) {
2939
/** The spec will take up the maximum size possible */
3040
ASRelativeLayoutSpecSizingOptionDefault,

0 commit comments

Comments
 (0)