Add DocC documentation catalogs to Essentials, Internationalization, and Preview modules. #283
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.
This PR is the first step of providing DocC-based documentation for Swift Foundation.
This PR adds
.docc
directories to FoundationEssentials, FoundationInternationalization, and Foundation (the top-level superset module). Along with providing an overview of each module, this PR performs an initial curation of top-level symbols into topic groups.It doesn't curate all symbols in all types; that can come later when each type is documented. However, some types (such as
AttributedString
andPredicate
) do get an initial curation for the sake of giving their helper types someplace to go.Generate documentation with Xcode's "Product -> Build Documentation" menu item, or via the
xcodebuild
command-line:On other platforms, you can use the Swift-DocC Plugin to generate documentation.