[CM-996] Add linter rules and fix violations

Author: Mark Pospesel

.swiftlint.yml

@@ -9,6 +9,8 @@ opt_in_rules: # some rules are turned off by default, so you need to opt-in
   - empty_count
   - first_where
   - force_unwrapping
+  - implicit_return
+  - missing_docs
   - multiline_arguments
   - multiline_arguments_brackets
   - multiline_function_chains

Sources/YMatterType/Typography/FontFamily/FontFamily.swift

@@ -70,13 +70,16 @@ extension Typography {
 
 // MARK: - Default implementations
 
+/// Default implementations
 extension FontFamily {
-    // returns no suffix
+    /// Returns no suffix
     public var fontNameSuffix: String { "" }
 
-    // returns all weights
+    /// Returns all weights
     public var supportedWeights: [Typography.FontWeight] { Typography.FontWeight.allCases }
 
+    /// Generates the font to be used using `UIFont(name:size:)` and the name generated by
+    /// `fontName(weight:traitCollection:)`
     public func font(
         for weight: Typography.FontWeight,
         pointSize: CGFloat,
@@ -95,6 +98,8 @@ extension FontFamily {
         return font
     }
 
+    /// Generates the font name by combining family name, the weight name
+    /// (potentially adjusted for Bold Text), and suffix.
     public func fontName(
         for weight: Typography.FontWeight,
         compatibleWith traitCollection: UITraitCollection?
@@ -106,6 +111,7 @@ extension FontFamily {
         return "\(familyName)-\(weightName)\(fontNameSuffix)"
     }
 
+    /// Returns default name for each weight
     public func weightName(for weight: Typography.FontWeight) -> String {
         // Default font name suffix by weight
         switch weight {
@@ -130,8 +136,8 @@ extension FontFamily {
         }
     }
 
+    /// Returns the next heavier supported weight (if any), otherwise the heaviest supported weight
     public func accessibilityBoldWeight(for weight: Typography.FontWeight) -> Typography.FontWeight {
-        // By default returns the next heavier supported weight (if any), otherwise the heaviest supported weight
         let weights = supportedWeights.sorted(by: { $0.rawValue < $1.rawValue })
         // return the next heavier supported weight
         return weights.first(where: { $0.rawValue > weight.rawValue }) ?? weights.last ?? weight