Skip to content

Commit

Permalink
Fix Xcode documentation comment warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
ibireme committed Aug 6, 2017
1 parent 749cde9 commit 7725c32
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion YYText/Component/YYTextLayout.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ extern const CGSize YYTextContainerMaxSize;
/// Creates a container with the specified size and insets. @param size The size. @param insets The text insets.
+ (instancetype)containerWithSize:(CGSize)size insets:(UIEdgeInsets)insets;

/// Creates a container with the specified path. @param size The path.
/// Creates a container with the specified path. @param path The path.
+ (instancetype)containerWithPath:(nullable UIBezierPath *)path;

/// The constrained size. (if the size is larger than YYTextContainerMaxSize, it will be clipped)
Expand Down
2 changes: 1 addition & 1 deletion YYText/Utility/NSAttributedString+YYText.h
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ NS_ASSUME_NONNULL_BEGIN
@param content The attachment (UIImage/UIView/CALayer).
@param contentMode The attachment's content mode in attachment holder
@param attachmentSize The attachment holder's size in text layout.
@param fontSize The attachment will align to this font.
@param font The attachment will align to this font.
@param alignment The attachment holder's alignment to text line.
@return An attributed string, or nil if an error occurs.
Expand Down
12 changes: 6 additions & 6 deletions YYText/Utility/YYTextAsyncLayer.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
This block will be called before the asynchronous drawing begins.
It will be called on the main thread.
@param layer The layer.
block param layer: The layer.
*/
@property (nullable, nonatomic, copy) void (^willDisplay)(CALayer *layer);

Expand All @@ -58,9 +58,9 @@ NS_ASSUME_NONNULL_BEGIN
@discussion This block may be called on main thread or background thread,
so is should be thread-safe.
@param context A new bitmap content created by layer.
@param size The content size (typically same as layer's bound size).
@param isCancelled If this block returns `YES`, the method should cancel the
block param context: A new bitmap content created by layer.
block param size: The content size (typically same as layer's bound size).
block param isCancelled: If this block returns `YES`, the method should cancel the
drawing process and return as quickly as possible.
*/
@property (nullable, nonatomic, copy) void (^display)(CGContextRef context, CGSize size, BOOL(^isCancelled)(void));
Expand All @@ -69,8 +69,8 @@ NS_ASSUME_NONNULL_BEGIN
This block will be called after the asynchronous drawing finished.
It will be called on the main thread.
@param layer The layer.
@param finished If the draw process is cancelled, it's `NO`, otherwise it's `YES`;
block param layer: The layer.
block param finished: If the draw process is cancelled, it's `NO`, otherwise it's `YES`;
*/
@property (nullable, nonatomic, copy) void (^didDisplay)(CALayer *layer, BOOL finished);

Expand Down
2 changes: 1 addition & 1 deletion YYText/Utility/YYTextUtilities.h
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ NSString *YYTextUIViewContentModeToCAGravity(UIViewContentMode contentMode);


/**
Returns a rectangle to fit the @param rect with specified content mode.
Returns a rectangle to fit the `rect` with specified content mode.
@param rect The constrant rect
@param size The content size
Expand Down

0 comments on commit 7725c32

Please sign in to comment.