Restore DocC @Comment blocks to documentation line comments
#1103
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
stmontgomery
added
documentation
stmontgomery
requested review from
grynspan,
briancroom and
suzannaratcliff
as code owners
|
@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.
This reverts a portion of the changes I made in #836 which converted triple-
///style DocC@Commentblocks to double-//style code comments. That change was needed at the time because our documentation was still rendered using pre-Swift 6.1 toolchains, but now@Commentblocks are supported by DocC in documentation comments (as of swiftlang/swift-docc#1107) so we can restore these.I needed to move some of these comment blocks up before
## See Alsosections to avoid a DocC warning about items in lists not being links.Checklist: