[Swiftify] Copy doc comment from clang node (#81584) #81640
Merged
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
Member
Author
|
@swift-ci please test |
j-hui
approved these changes
May 20, 2025
hnrklssn
force-pushed
the
swiftify-doccoment-6.2
branch
from
17221f1 to
3bbf785
Compare
Member
Author
|
@swift-ci please test |
hnrklssn
force-pushed
the
swiftify-doccoment-6.2
branch
from
3bbf785 to
c9d51aa
Compare
Member
Author
|
@swift-ci please test |
Swift nodes imported from clang don't have doc comments carried over, but IDEs are clever enough to fetch the comments from the associated clang node. The swift node in the macro expansion from _SwiftifyImport doesn't have a clang node directly associated with it however. This patch adds the same comment from the clang node to the _SwiftifyImport macro invocation node. Since the macro has access to this node, it can easily copy over its leading trivia. For now the comment is not altered at all, meaning @param still remains even if the parmeter is removed. rdar://151346977 (cherry picked from commit 6534b9b)
hnrklssn
force-pushed
the
swiftify-doccoment-6.2
branch
from
c9d51aa to
341ee51
Compare
Member
Author
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Swift nodes imported from clang don't have doc comments carried over, but IDEs are clever enough to fetch the comments from the associated clang node. The swift node in the macro expansion from _SwiftifyImport doesn't have a clang node directly associated with it however.
This patch adds the same comment from the clang node to the _SwiftifyImport macro invocation node. Since the macro has access to this node, it can easily copy over its leading trivia.
For now the comment is not altered at all, meaning @param still remains even if the parameter is removed.
This does not break any existing code, because it only affects code using the SafeInteropWrappers feature, which so far is none.
rdar://151346977
[Swiftify] Copy doc comment from clang node #81584
Low
Manual testing in Xcode
@j-hui @DougGregor