Support resolving links in @DeprecationSummary
content
#784
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: rdar://120374614
Summary
This adds support for resolving links in a symbol's
@DeprecationSummary
content.Previously the
ReferenceResolver
didn't visit a symbol'sdeprecatedSummaryVariants
so any link in that content didn't resolve but also didn't warn about the links being unresolved.Dependencies
None
Testing
In a documentation catalog with any symbol, add documentation extension file with a
@DeprecationSummary
directive that has a link in its content.Build and preview the documentation. The deprecation summary should link to the other page.
Replace the link with something that won't resolve—for example
``NotFound``
—and rebuild the documentation. There should be a warning about the unresolved link.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded[ ] Updated documentation if necessary