Support @PageImage in in-source documentation comments #1412
+62
−11
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: #1403
Summary
Previously,
@PageImagedirectives were rejected when used in documentation comments with a warning suggesting to use a documentation extension file instead. This change removes that restriction, allowing developers to specify page images directly in their source code comments.This aligns
@PageImagebehavior with@Available, which is already supported in documentation comments.Implementation:
@PageImageinMetadata.validateForUseInDocumentationComment()pageImagesarray for documentation commentsDependencies
None.
Testing
swift buildswift test --filter SymbolTeststestParsesPageImageDirectiveFromDocCommenttestParsesMultiplePageImageDirectivesFromDocCommentChecklist
./bin/testscript and it succeeded