[5.7] [SymbolGraphGen] Add filename and module name to symbols' doc comments #58964
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
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.
Cherry-pick of #58857
Explanation: This PR adds new fields to the
docCommentstructure in symbol graphs:uriandmodule, to indicate where given documentation came from. When documentation is inherited, the comment could from a different file or even a different module, creating confusing situations if a tool needs to parse these comments, like Swift-DocC does for symbol links. Adding this information allows Swift-DocC to emit the right source location for warnings it might emit based on doc comment information.Scope: Restricted to SymbolGraphGen - the new fields are not emitted if the information is not available.
Bug: rdar://81190369
Risk: Low. This should not affect normal compilation.
Testing: A new lit test,
SymbolGraph/Symbols/Mixins/DocComment/SourceModule.swift, has been added to verify that the source module correctly indicates where a doc comment came from. Existing lit tests which verifieddocCommentinformation have also been updated to reflect the new data.