소스 검색

Fix Xcode documentation comment warnings

ibireme 8 년 전
부모
커밋
7725c32cc3
4개의 변경된 파일9개의 추가작업 그리고 9개의 파일을 삭제
  1. 1 1
      YYText/Component/YYTextLayout.h
  2. 1 1
      YYText/Utility/NSAttributedString+YYText.h
  3. 6 6
      YYText/Utility/YYTextAsyncLayer.h
  4. 1 1
      YYText/Utility/YYTextUtilities.h

+ 1 - 1
YYText/Component/YYTextLayout.h

@@ -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)

+ 1 - 1
YYText/Utility/NSAttributedString+YYText.h

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

+ 6 - 6
YYText/Utility/YYTextAsyncLayer.h

@@ -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);
 
@@ -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));
@@ -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);
 

+ 1 - 1
YYText/Utility/YYTextUtilities.h

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