Skip to content

Commit c319e75

Browse files
RISCfutureclaude
andcommitted
Fix DocC warnings and enforce a clean documentation build in CI
Drops the no-op @metadata mergeBehavior blocks, updates the CIFP initializer links for the progressHandler:/totalBytes: parameters added alongside progress reporting, and removes the Creating Coordinates topic — both initializers it listed are internal. Adds a CI job that runs generate-documentation with --warnings-as-errors, so a DocC warning fails the build instead of landing silently. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 2c0718e commit c319e75

11 files changed

Lines changed: 17 additions & 48 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 --allow-writing-to-directory "$RUNNER_TEMP/docs" \
55+
generate-documentation --target SwiftCIFP \
56+
--warnings-as-errors \
57+
--output-path "$RUNNER_TEMP/docs"
4458
lint:
4559
name: Run SwiftLint
4660
runs-on: ubuntu-latest

Sources/SwiftCIFP/Documentation.docc/Airport.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``Airport``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Identification

Sources/SwiftCIFP/Documentation.docc/Airway.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``Airway``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Identification

Sources/SwiftCIFP/Documentation.docc/Approach.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``Approach``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Identification

Sources/SwiftCIFP/Documentation.docc/CIFP.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
# ``CIFP``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Parsing CIFP Data
106

11-
- ``init(data:errorCallback:)``
12-
- ``init(url:errorCallback:)``
13-
- ``init(bytes:errorCallback:)``
7+
- ``init(data:progressHandler:errorCallback:)``
8+
- ``init(url:progressHandler:errorCallback:)``
9+
- ``init(bytes:totalBytes:progressHandler:errorCallback:)``
1410

1511
### Creating Linked Data
1612

Sources/SwiftCIFP/Documentation.docc/CIFPData.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``CIFPData``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Creating CIFPData

Sources/SwiftCIFP/Documentation.docc/Coordinate.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,7 @@
11
# ``Coordinate``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

9-
### Creating Coordinates
10-
11-
- ``init(latitudeDeg:longitudeDeg:)``
12-
- ``init(_:)``
13-
145
### Decimal Degrees
156

167
- ``latitudeDeg``

Sources/SwiftCIFP/Documentation.docc/Fix.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``Fix``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Cases

Sources/SwiftCIFP/Documentation.docc/ProcedureLeg.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``ProcedureLeg``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Identification

Sources/SwiftCIFP/Documentation.docc/Runway.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# ``Runway``
22

3-
@Metadata {
4-
@DocumentationExtension(mergeBehavior: append)
5-
}
6-
73
## Topics
84

95
### Identification

0 commit comments

Comments
 (0)