Add documentation for --include-extended-types and --help flags.
#53
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
|
@swift-ci please test |
franklinsch
reviewed
Mar 14, 2023
| @@ -0,0 +1,35 @@ | |||
| # Generating Documentation for Extended Types | |||
|
|
|||
| Generate documentation for the extensions you make to types from other modules. | |||
There was a problem hiding this comment.
Up to you; including a screenshot of an extended type or module could be nice so that you see how these extended types will show up in your docs.
| public extension ExternalType { | ||
| /// This function is not included in | ||
| /// the documentation by default. | ||
| func foo() { } |
There was a problem hiding this comment.
Is there a more real-world/relatable code example we could use here instead of foo? Maybe extending the standard library?
There was a problem hiding this comment.
Well...I'm not sure if it is relatable, but it features Sloths!
…d Types documentation
| @@ -33,6 +33,10 @@ following from the command-line: | |||
|
|
|||
| $ swift package generate-documentation | |||
|
|
|||
| Use the `--help` flag to get a list of all supported arguments: | |||
|
|
|||
| $ swift package plugin generate-documentation --help | |||
There was a problem hiding this comment.
I think this is worth leaving for legacy reasons but just FYI – this was fixed in a recent version of ArgumentParser that SwiftPM adopted and should be resolved in nightly toolchains. So soon just this will work:
swift package generate-documentation --help
ethan-kusters
approved these changes
Mar 16, 2023
Sources/SwiftDocCPluginDocumentation/SwiftDocCPlugin.docc/Resources/extended-type-example.png
Outdated
Show resolved
Hide resolved
...tDocCPluginDocumentation/SwiftDocCPlugin.docc/Generating Documentation for Extended Types.md
Show resolved
Hide resolved
...tDocCPluginDocumentation/SwiftDocCPlugin.docc/Generating Documentation for Extended Types.md
Outdated
Show resolved
Hide resolved
...tDocCPluginDocumentation/SwiftDocCPlugin.docc/Generating Documentation for Extended Types.md
Show resolved
Hide resolved
|
@swift-ci please test |
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.
(Bug/issue #, if applicable: swiftlang/swift-docc#210)
Summary
Adds a new doc page for the
--include-extended-typesflag.This PR also adds a hint on how to access the
--helpflag to the landing page. I think that many people don't know you have to add theswift package pluginsubcommand to get access to the plugin's help text.Dependencies
None.
Testing
N/A
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
Added testsN/A./bin/testscript and it succeeded