use docc

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Swift
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  macos:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Generate documentation
+      run: |
+        swift package --allow-writing-to-directory docs generate-documentation \
+        --target BigInt \
+        --disable-indexing \
+        --output-path docs \
+        --transform-for-static-hosting
+    - name: Commit docs
+      run: |
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Actions"
+        git add ./docs
+        git commit -m "Update docs"
+        git push origin HEAD:master

Package.swift

@@ -21,6 +21,9 @@ let package = Package(
     ],
     products: [
         .library(name: "BigInt", targets: ["BigInt"])
+    ], 
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [
         .target(name: "BigInt", path: "Sources"),

Sources/Multiplication.swift

@@ -40,7 +40,7 @@ extension BigUInt {
     ///
     /// - Note: This is the fused multiply/shift/add operation; it is more efficient than doing the components
     ///   individually. (The fused operation doesn't need to allocate space for temporary big integers.)
-    /// - Returns: `self` is set to `self + (x * y) << (shift * 2^Word.bitWidth)`
+    ///   `self` is set to `self + (x * y) << (shift * 2^Word.bitWidth)`
     /// - Complexity: O(count)
     public mutating func multiplyAndAdd(_ x: BigUInt, _ y: Word, shiftedBy shift: Int = 0) {
         precondition(shift >= 0)