Repository navigation
DeallocTests 4.0 (6/6): DocC documentation - #31
Open
DanielCech wants to merge 1 commit into
Open
DanielCech wants to merge 1 commit into
DanielCech wants to merge 1 commit into
Conversation
A Documentation.docc catalog with a landing page that groups the API into topics, a Lifecycle page, and three articles moved from the README: Getting Started, Configuration and Grace Period, and Migrating to 4.0. The README keeps installation and a quick start and links to the articles. .spi.yml builds the iOS variant, where the UIKit lifecycles exist. A CI job builds the documentation and fails on warnings from this package, such as an unresolved symbol link or an undocumented parameter. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part 6 of 6. DeallocTests 4.0 series (merge in order): #25 groundwork → #26
expectDeallocation→ #27 tracking, hints, DI → #28 configuration → #29 remove legacy, docs → #31 DocC.Add DocC documentation for the 4.0 API, to be hosted on Swift Package Index.
Why
DocC is the usual way Swift packages document their API, and it shows up in Xcode's Quick Help and documentation window. Until now the README was the only documentation, so it carried the whole API, the configuration and the migration guide in one 330-line page. Nearly every public symbol already had a doc comment; what was missing was a catalog that organizes them and a place for the longer guides.
What changes
Sources/DeallocTests/Documentation.docc:Lifecyclepage that groups its members: any object, view controllers, SwiftUI..spi.yml: Swift Package Index builds the docs for the iOS variant, where.presentand.pushexist.Documentation (iOS)job runsxcodebuild docbuildand fails on documentation warnings from this package, such as an unresolved symbol link or an undocumented parameter. The STRV Dependency Injection package has documentation warnings of its own, and the job ignores those.expectDeallocationoverloads are documented, which was the only thing DocC warned about.No
swift-docc-plugindependency: SPI doesn't need it, and consumers don't have to resolve it.After merging
The documentation links in the README and the CHANGELOG point to
swiftpackageindex.com/strvcom/DeallocTests/documentation/dealloctests. They work once the package is added to Swift Package Index (a one-time submission at swiftpackageindex.com/add-a-package, which needs a tagged release). Until then they return 404.How to review
Read the articles in
Documentation.docc; most of the text is the README content, reorganized. To see the rendered docs, open the package in Xcode and choose Product › Build Documentation.Testing
xcodebuild docbuildfor iOS succeeds with no warnings from this package, and every symbol link resolves.swift buildpasses; the only source change is doc comments.🤖 Generated with Claude Code