Correct documentation comments

This commit is contained in:
Eric Jensen
2016-03-24 20:01:27 -07:00
parent 7de48da44f
commit 057ec55941
4 changed files with 10 additions and 10 deletions

View File

@@ -66,12 +66,12 @@ typedef NS_ENUM(NSUInteger, ASCellNodeVisibilityEvent) {
//@property (atomic, retain) UIColor *backgroundColor; //@property (atomic, retain) UIColor *backgroundColor;
@property (nonatomic) UITableViewCellSelectionStyle selectionStyle; @property (nonatomic) UITableViewCellSelectionStyle selectionStyle;
/* /**
* A Boolean value that indicates whether the node is selected. * A Boolean value that indicates whether the node is selected.
*/ */
@property (nonatomic, assign) BOOL selected; @property (nonatomic, assign) BOOL selected;
/* /**
* A Boolean value that indicates whether the node is highlighted. * A Boolean value that indicates whether the node is highlighted.
*/ */
@property (nonatomic, assign) BOOL highlighted; @property (nonatomic, assign) BOOL highlighted;

View File

@@ -18,7 +18,7 @@ NS_ASSUME_NONNULL_BEGIN
*/ */
@interface ASEditableTextNode : ASDisplayNode @interface ASEditableTextNode : ASDisplayNode
// @abstract The text node's delegate, which must conform to the <ASEditableTextNodeDelegate> protocol. //! @abstract The text node's delegate, which must conform to the <ASEditableTextNodeDelegate> protocol.
@property (nonatomic, readwrite, weak) id <ASEditableTextNodeDelegate> delegate; @property (nonatomic, readwrite, weak) id <ASEditableTextNodeDelegate> delegate;
#pragma mark - Configuration #pragma mark - Configuration
@@ -66,12 +66,12 @@ NS_ASSUME_NONNULL_BEGIN
//! @abstract The text input mode used by the receiver's keyboard, if it is visible. This value is undefined if the receiver is not the first responder. //! @abstract The text input mode used by the receiver's keyboard, if it is visible. This value is undefined if the receiver is not the first responder.
@property (nonatomic, readonly) UITextInputMode *textInputMode; @property (nonatomic, readonly) UITextInputMode *textInputMode;
/* /**
@abstract The textContainerInset of both the placeholder and typed textView. This value defaults to UIEdgeInsetsZero. @abstract The textContainerInset of both the placeholder and typed textView. This value defaults to UIEdgeInsetsZero.
*/ */
@property (nonatomic, readwrite) UIEdgeInsets textContainerInset; @property (nonatomic, readwrite) UIEdgeInsets textContainerInset;
/* /**
@abstract The returnKeyType of the keyboard. This value defaults to UIReturnKeyDefault. @abstract The returnKeyType of the keyboard. This value defaults to UIReturnKeyDefault.
*/ */
@property (nonatomic, readwrite) UIReturnKeyType returnKeyType; @property (nonatomic, readwrite) UIReturnKeyType returnKeyType;

View File

@@ -38,7 +38,7 @@ typedef void (^ASDataControllerCompletionBlock)(NSArray<ASCellNode *> *nodes, NS
*/ */
- (void)batchLayoutNodesFromContexts:(NSArray<ASIndexedNodeContext *> *)contexts ofKind:(NSString *)kind completion:(ASDataControllerCompletionBlock)completionBlock; - (void)batchLayoutNodesFromContexts:(NSArray<ASIndexedNodeContext *> *)contexts ofKind:(NSString *)kind completion:(ASDataControllerCompletionBlock)completionBlock;
/* /**
* Perform measurement and layout of loaded nodes on the main thread, skipping unloaded nodes. * Perform measurement and layout of loaded nodes on the main thread, skipping unloaded nodes.
* *
* @discussion Once nodes have loaded their views, we can't layout in the background so this is a chance * @discussion Once nodes have loaded their views, we can't layout in the background so this is a chance

View File

@@ -58,7 +58,7 @@
@property (nonatomic, assign, readonly) CGFloat currentScaleFactor; @property (nonatomic, assign, readonly) CGFloat currentScaleFactor;
#pragma mark - Drawing #pragma mark - Drawing
/* /**
Draw the renderer's text content into the bounds provided. Draw the renderer's text content into the bounds provided.
@param bounds The rect in which to draw the contents of the renderer. @param bounds The rect in which to draw the contents of the renderer.
@@ -67,20 +67,20 @@
#pragma mark - Layout #pragma mark - Layout
/* /**
Returns the computed size of the renderer given the constrained size and other parameters in the initializer. Returns the computed size of the renderer given the constrained size and other parameters in the initializer.
*/ */
- (CGSize)size; - (CGSize)size;
#pragma mark - Text Ranges #pragma mark - Text Ranges
/* /**
The character range from the original attributedString that is displayed by the renderer given the parameters in the The character range from the original attributedString that is displayed by the renderer given the parameters in the
initializer. initializer.
*/ */
- (std::vector<NSRange>)visibleRanges; - (std::vector<NSRange>)visibleRanges;
/* /**
The number of lines shown in the string. The number of lines shown in the string.
*/ */
- (NSUInteger)lineCount; - (NSUInteger)lineCount;