Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Documentation Warnings #trivial #276

Merged
merged 1 commit into from
May 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Source/Private/TextExperiment/Component/ASTextLayout.h
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions Source/Private/TextExperiment/Utility/ASTextUtilities.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down