add API reference documentation for PackagePlugin #8830
Conversation
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
heckj
changed the title
…tracts across the public API of the module, resolving warnings for doc comments to argument mismatches
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.
Adds API reference documentation for PackagePlugin
resolves #8827
Motivation:
PackagePlugin is API reference for anyone creating Swift Package Manager plugins - either build tools or command tools. This curates the content into a DocC catalog as API reference to support the more general SwiftPM documentation on plugins in the PackageManagerDocs target.
Modifications:
Result:
Preview:
To preview the work for this pull request locally:
swift package --disable-sandbox preview-documentation --target PackagePlugin