[CM-604] Update comments

codeandtheory · Jun 6, 2022 · ab01ed6 · ab01ed6
1 parent 43d58ea
commit ab01ed6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/Sources/YMatterType/Typography/Typography+Font.swift b/Sources/YMatterType/Typography/Typography+Font.swift
@@ -15,7 +15,7 @@ extension Typography {
     /// - Parameters:
     ///   - maximumPointSize: (optional) maximum point size for Dynamic Type, default = nil, means no maximum
     ///   - traitCollection: trait collection to apply (looking for preferredContentSizeCategory and legibilityWeight)
-    /// - Returns: Font, line height multiple, and paragraph style to render the Typography
+    /// - Returns: Font and various styles used to render the Typography
     public func generateLayout(
         maximumPointSize: CGFloat? = nil,
         compatibleWith traitCollection: UITraitCollection?
@@ -88,7 +88,7 @@ extension Typography {
     ///   - maximumScaleFactor: (optional) maximum scale factor for Dynamic Type,
     ///   e.g. `2.0` for a 16 pt font would mean limit maximum point size to 32 pts.
     ///   - traitCollection: trait collection to apply (looking for preferredContentSizeCategory and legibilityWeight)
-    /// - Returns: Font, line height multiple, and paragraph style to render the Typography
+    /// - Returns: Font and various styles used to render the Typography
     public func generateLayout(
         maximumScaleFactor: CGFloat,
         compatibleWith traitCollection: UITraitCollection?
@@ -109,7 +109,7 @@ extension Typography {
     ///   e.g. `2.0` for a 16 pt font would mean limit maximum point size to 32 pts.
     ///   - maximumPointSize: (optional) maximum point size for Dynamic Type, nil means no maximum point size.
     ///   - traitCollection: trait collection to apply (looking for preferredContentSizeCategory and legibilityWeight)
-    /// - Returns: Font, line height multiple, and paragraph style to render the Typography
+    /// - Returns: Font and various styles used to render the Typography
     internal func generateLayout(
         maximumScaleFactor: CGFloat?,
         maximumPointSize: CGFloat?,

diff --git a/Sources/YMatterType/Typography/TypographyLayout.swift b/Sources/YMatterType/Typography/TypographyLayout.swift
@@ -30,7 +30,7 @@ public struct TypographyLayout {
     /// Text decoration to apply
     public let textDecoration: Typography.TextDecoration
 
-    /// Paragraph style with the correct line height multiple (to achieve the desired line height)
+    /// Paragraph style with the correct line height for rendering multi-line text
     public let paragraphStyle: NSParagraphStyle
 
     /// Line height multiple to use with this font (to achieve the desired line height)