docs: document extenstions

rhwood · Jul 2, 2023 · 74f3018 · 74f3018
1 parent baf3fba
commit 74f3018
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -21,7 +21,8 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: macos-12
+    # change to macos-latest once macos-13 becomes the latest
+    runs-on: macos-13
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v3
@@ -30,14 +31,15 @@ jobs:
           export DOCC_JSON_PRETTYPRINT="YES"
           swift package generate-documentation \
             --target WMATAUI \
+            --include-extended-types \
             --disable-indexing \
             --transform-for-static-hosting \
             --hosting-base-path WMATAUI.swift
       - name: Upload artifact 📜
         uses: actions/upload-pages-artifact@v1
         with:
           # Upload docs directory
-          path: .build/plugins/Swift-DocC/outputs/WMATAUI.docarchive
+          path: .build/plugins/Swift-DocC/outputs/WMATAUI.doccarchive
       - name: Deploy to GitHub Pages 🐙
         id: deployment
         uses: actions/deploy-pages@v1
diff --git a/Sources/WMATAUI/WMATAUI.swift b/Sources/WMATAUI/WMATAUI.swift
@@ -8,6 +8,7 @@
 import SwiftUI
 import WMATA
 
+/// Static functions to create WMATA branded roundels.
 public struct WMATAUI {
 
     /// Get a color dot sized for the given text style.

diff --git a/Sources/WMATAUI/WMATAUIFont.swift b/Sources/WMATAUI/WMATAUIFont.swift
@@ -14,12 +14,14 @@ public typealias WMATAUIFont = UIFont
 #endif
 import SwiftUI
 
+/// Helper function to deal with fonts.
 @available(macOS 11.0, *)
 public extension WMATAUIFont.TextStyle {
 
     // rule triggered by tvOS macro, so disabling
     // swiftlint:disable cyclomatic_complexity
-    /// Convert a Font.TextStyle to a UIFont.TextStyle
+    /// Convert a Font.TextStyle to a NSFont.TextStyle (if using AppKit) or UIFont.TextStyle (if using UIKit))
+    /// Note that on tvOS, this converts Font.TextStyle.largeTitle the same as Font.TextStyle.title
     static func with(textStyle: Font.TextStyle) -> WMATAUIFont.TextStyle {
         let style: WMATAUIFont.TextStyle