[Swiftify] Copy doc comment from clang node #81584
Conversation
hnrklssn
requested review from
Xazax-hun,
beccadax,
egorzhdan,
fahadnayyar,
ian-twilightcoder,
j-hui,
susmonteiro and
zoecarver
as code owners
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
j-hui
left a comment
j-hui
left a comment
There was a problem hiding this comment.
This looks good to me, but I'm wondering whether it's easy to write a test to make sure that SourceKit picks up the comment attached to the macro-generated overload?
delcypher
left a comment
delcypher
left a comment
There was a problem hiding this comment.
Seems reasonable. I do have a suggestion about tweaking the doc comment a little though
lib/ClangImporter/ImportDecl.cpp
Outdated
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 |
|
@swift-ci please smoke test windows |
test/SourceKit/CursorInfo/cursor_doc_comment_from_clang_safe_wrapper.swift
Show resolved
Hide resolved
|
@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 (cherry picked from commit 6534b9b)
[Swiftify] Copy doc comment from clang node (#81584)
5 participants
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