This is an archive of the discontinued LLVM Phabricator instance.

Differential D107365

clangd: Make documentation property of completion items more similar
ClosedPublic

Authored by ckandeler on Aug 3 2021, 9:01 AM.

Details

Reviewers
sammccall
Commits
rG6b28835b3754: clangd: Make documentation property of completion items more similar
Summary

... to the one of signature hints.
In particular, completion items now also carry annotations, which client
code might be interested in.

Diff Detail

Event Timeline

ckandeler created this revision.Aug 3 2021, 9:01 AM
Herald added subscribers: usaxena95, kadircet, arphaman. · View Herald TranscriptAug 3 2021, 9:01 AM
ckandeler requested review of this revision.Aug 3 2021, 9:01 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 3 2021, 9:01 AM
Herald added subscribers: cfe-commits, MaskRay, ilya-biryukov. · View Herald Transcript
Harbormaster completed remote builds in B117660: Diff 363762.Aug 3 2021, 10:02 AM
ckandeler updated this revision to Diff 364412.Aug 5 2021, 4:24 AM

Addressed lint complaints.

Harbormaster completed remote builds in B118126: Diff 364412.Aug 5 2021, 5:32 AM
sammccall accepted this revision.Aug 6 2021, 5:46 AM

LG but could you please add a test showing this difference?

This revision is now accepted and ready to land.Aug 6 2021, 5:46 AM
ckandeler updated this revision to Diff 364790.Aug 6 2021, 7:29 AM

Added test coverage.

Harbormaster completed remote builds in B118380: Diff 364790.Aug 6 2021, 8:15 AM
This revision was landed with ongoing or failed builds.Aug 12 2021, 3:18 PM
Closed by commit rG6b28835b3754: clangd: Make documentation property of completion items more similar (authored by ckandeler, committed by sammccall). · Explain Why
This revision was automatically updated to reflect the committed changes.
sammccall added a commit: rG6b28835b3754: clangd: Make documentation property of completion items more similar.

Revision Contents

PathSize
clang-tools-extra/
clangd/
5 lines
unittests/
5 lines

Diff 366128

clang-tools-extra/clangd/CodeComplete.cpp

Show First 20 Lines • Show All 397 Lines • ▼ Show 20 Lines if (!Completion.Documentation) {
if (!Doc.empty()) { if (!Doc.empty()) {
Completion.Documentation.emplace(); Completion.Documentation.emplace();
parseDocumentation(Doc, *Completion.Documentation); parseDocumentation(Doc, *Completion.Documentation);
} }
}; };
if (C.IndexResult) { if (C.IndexResult) {
SetDoc(C.IndexResult->Documentation); SetDoc(C.IndexResult->Documentation);
} else if (C.SemaResult) { } else if (C.SemaResult) {
SetDoc(getDocComment(*ASTCtx, *C.SemaResult, const auto DocComment = getDocComment(*ASTCtx, *C.SemaResult,
/*CommentsFromHeader=*/false)); /*CommentsFromHeader=*/false);
SetDoc(formatDocumentation(*SemaCCS, DocComment));
} }
} }
if (Completion.Deprecated) { if (Completion.Deprecated) {
if (C.SemaResult) if (C.SemaResult)
Completion.Deprecated &= Completion.Deprecated &=
C.SemaResult->Availability == CXAvailability_Deprecated; C.SemaResult->Availability == CXAvailability_Deprecated;
if (C.IndexResult) if (C.IndexResult)
Completion.Deprecated &= Completion.Deprecated &=
▲ Show 20 Lines • Show All 1,649 Lines • Show Last 20 Lines

clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp

Show First 20 Lines • Show All 901 Lines • ▼ Show 20 Lines EXPECT_THAT(Results.Completions,
Contains((Named("fooooo"), Kind(CompletionItemKind::Function), Contains((Named("fooooo"), Kind(CompletionItemKind::Function),
Doc("Doooc"), ReturnType("void")))); Doc("Doooc"), ReturnType("void"))));
} }
TEST(CompletionTest, Documentation) { TEST(CompletionTest, Documentation) {
auto Results = completions( auto Results = completions(
R"cpp( R"cpp(
// Non-doxygen comment. // Non-doxygen comment.
int foo(); __attribute__((annotate("custom_annotation"))) int foo();
/// Doxygen comment. /// Doxygen comment.
/// \param int a /// \param int a
int bar(int a); int bar(int a);
/* Multi-line /* Multi-line
block comment block comment
*/ */
int baz(); int baz();
int x = ^ int x = ^
)cpp"); )cpp");
EXPECT_THAT(Results.Completions, EXPECT_THAT(Results.Completions,
Contains(AllOf(Named("foo"), Doc("Non-doxygen comment.")))); Contains(AllOf(Named("foo"),
Doc("Annotation: custom_annotation\nNon-doxygen comment."))));
EXPECT_THAT( EXPECT_THAT(
Results.Completions, Results.Completions,
Contains(AllOf(Named("bar"), Doc("Doxygen comment.\n\\param int a")))); Contains(AllOf(Named("bar"), Doc("Doxygen comment.\n\\param int a"))));
EXPECT_THAT(Results.Completions, EXPECT_THAT(Results.Completions,
Contains(AllOf(Named("baz"), Doc("Multi-line block comment")))); Contains(AllOf(Named("baz"), Doc("Multi-line block comment"))));
} }
TEST(CompletionTest, CommentsFromSystemHeaders) { TEST(CompletionTest, CommentsFromSystemHeaders) {
▲ Show 20 Lines • Show All 2,336 Lines • Show Last 20 Lines