Support linkable attribute tokens #636
Merged
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: 108472125
Summary
This adds support for rendering certain attribute tokens as links to symbols instead of just plaintext.
As a basic example, DocC would generate a linkable
@StringBuildertoken in the contrivedbuildABCfunction here:Dependencies
swiftlang/swift#63637
Testing
To test this using swift-docc-plugin, you may need a recent 5.9 toolchain version of Swift to ensure that the symbol graph tokens get generated with the data for linking (see above dependency).
Steps:
npm run buildenv DOCC_HTML_DIR=/path/to/dist swift package --disable-sandbox preview-documentation --target [target]Here is an example package (target "AttributeExamples") that has the
@StringBuilderexample code from above:AttributeExamples.zip
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded