[Swiftify] Copy doc comment from clang node #81584
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
hnrklssn
requested review from
zoecarver,
egorzhdan,
Xazax-hun,
j-hui,
fahadnayyar,
susmonteiro,
beccadax and
ian-twilightcoder
as code owners
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
j-hui
approved these changes
May 17, 2025
delcypher
reviewed
May 17, 2025
| // to. Waiting until we know that the macro will be attached before | ||
| // emitting the comment to the string, despite the comment occurring | ||
| // first, avoids copying a bunch of potentially long comments for nodes | ||
| // that don't end up with wrappers. |
There was a problem hiding this comment.
We might want to add a comment here that references an issue (or radar) about the fact that@param and might need to be rewritten.
There was a problem hiding this comment.
I think this is a minor enough potential future QoL improvement that it doesn't warrant polluting the code with discussion around it
hnrklssn
requested review from
ahoppen,
bnbarham,
hamishknight and
rintaro
as code owners
|
@swift-ci please smoke test |
It was actually easier than I thought! And I was able to verify that adding our custom line comment still is considered part of the same docs even if the rest uses block comments, which simplifies that implementation a lot. |
|
@swift-ci please smoke 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
hnrklssn
force-pushed
the
swiftify-doccomment
branch
from
900eb32 to
a907481
Compare
|
@swift-ci please smoke test |
DougGregor
approved these changes
May 18, 2025
|
@swift-ci please smoke test windows |
bnbarham
reviewed
May 19, 2025
test/SourceKit/CursorInfo/cursor_doc_comment_from_clang_safe_wrapper.swift
Show resolved
Hide resolved
|
@swift-ci please smoke test |
hnrklssn
added a commit
to hnrklssn/swift
that referenced
this pull request
May 20, 2025
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)
hamishknight
added a commit
to hamishknight/swift
that referenced
this pull request
May 22, 2025
This reverts commit 6534b9b.
hnrklssn
added a commit
to hnrklssn/swift
that referenced
this pull request
May 24, 2025
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
added a commit
to hnrklssn/swift
that referenced
this pull request
May 29, 2025
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
added a commit
to hnrklssn/swift
that referenced
this pull request
May 29, 2025
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) (cherry picked from commit c9d51aa)
hnrklssn
added a commit
to hnrklssn/swift
that referenced
this pull request
May 29, 2025
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
added a commit
to hnrklssn/swift
that referenced
this pull request
May 29, 2025
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
added a commit
that referenced
this pull request
May 30, 2025
[Swiftify] Copy doc comment from clang node (#81584)
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.
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