Skip to content

Commit 6b5175b

Browse files
RISCfutureclaude
andcommitted
Fix DocC links and enforce documentation warnings in CI
The catalog still named the pre-progress-handling initializers, so none of the six links resolved. A new CI job builds the documentation with --warnings-as-errors, so a broken link fails the build instead of shipping quietly. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 8b9b300 commit 6b5175b

3 files changed

Lines changed: 21 additions & 7 deletions

File tree

.github/workflows/ci.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,20 @@ jobs:
4141
run: swift build -v
4242
- name: Test
4343
run: swift test -v
44+
docs:
45+
name: Build Documentation
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: actions/checkout@v6
49+
- uses: SwiftyLab/setup-swift@latest
50+
with:
51+
swift-version: "6.2"
52+
- name: Build documentation
53+
run: |
54+
swift package \
55+
--allow-writing-to-directory "$RUNNER_TEMP/docs" \
56+
generate-documentation --target SwiftDOF --output-path "$RUNNER_TEMP/docs" \
57+
--warnings-as-errors
4458
lint:
4559
name: Run SwiftLint
4660
runs-on: ubuntu-latest

Sources/SwiftDOF/Documentation.docc/DOF.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
### Parsing a DOF
66

7-
- ``init(data:errorCallback:)``
8-
- ``init(url:errorCallback:)``
9-
- ``init(bytes:errorCallback:)``
10-
- ``from(filePath:errorCallback:)``
11-
- ``from(data:errorCallback:)``
12-
- ``from(url:errorCallback:)``
7+
- ``init(data:progressHandler:errorCallback:)``
8+
- ``init(url:progressHandler:errorCallback:)``
9+
- ``init(bytes:totalBytes:progressHandler:errorCallback:)``
10+
- ``from(filePath:progressHandler:errorCallback:)``
11+
- ``from(data:progressHandler:errorCallback:)``
12+
- ``from(url:progressHandler:errorCallback:)``
1313

1414
### Properties
1515

Sources/SwiftDOF/Documentation.docc/Documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Key features:
2323
SwiftDOF uses **strict parsing** - it throws errors for any malformed or invalid
2424
data rather than silently accepting it. This ensures data integrity and makes
2525
debugging easier. All parsing errors are reported via either thrown exceptions or
26-
the ``DOF/init(data:errorCallback:)`` callback parameter.
26+
the ``DOF/init(data:progressHandler:errorCallback:)`` callback parameter.
2727

2828
## Topics
2929

0 commit comments

Comments
 (0)