Fix documentation warnings (#276)

TextureGroup · May 15, 2017 · a1b6fd2 · a1b6fd2
1 parent b32e69d
commit a1b6fd2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/Source/Private/TextExperiment/Component/ASTextLayout.h b/Source/Private/TextExperiment/Component/ASTextLayout.h
@@ -58,7 +58,7 @@ extern const CGSize ASTextContainerMaxSize;
 /// 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 ASTextContainerMaxSize, it will be clipped)

diff --git a/Source/Private/TextExperiment/Utility/ASTextUtilities.h b/Source/Private/TextExperiment/Utility/ASTextUtilities.h
@@ -185,9 +185,9 @@ static inline UIEdgeInsets ASTextUIEdgeInsetsInvert(UIEdgeInsets insets) {
 }
 
 /**
- Returns a rectangle to fit the @param rect with specified content mode.
+ Returns a rectangle to fit `rect` with specified content mode.
  
- @param rect The constrant rect
+ @param rect The constraint rect
  @param size The content size
  @param mode The content mode
  @return A rectangle for the given content mode.

diff --git a/Source/Private/TextExperiment/Utility/NSAttributedString+ASText.h b/Source/Private/TextExperiment/Utility/NSAttributedString+ASText.h
@@ -620,7 +620,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.