[clangd] If an undocumented definition exists, don't accept documentation from other forward decls.
Summary:
This fixes cases like:
foo.h
class Undocumented{}
bar.h
// break an include cycle. we should refactor this!
class Undocumented;
Where the comment doesn't describe the class.
Note that a forward decl that is *visible to the definition* will still have
its doc comment used, by SymbolCollector: Merge isn't involved here.
Reviewers: ilya-biryukov
Subscribers: MaskRay, jkorous, arphaman, kadircet, usaxena95, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D68467
git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@373892 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/clangd/index/Merge.cpp b/clangd/index/Merge.cpp
index 829b7d0..76c5955 100644
--- a/clangd/index/Merge.cpp
+++ b/clangd/index/Merge.cpp
@@ -186,7 +186,10 @@
S.Signature = O.Signature;
if (S.CompletionSnippetSuffix == "")
S.CompletionSnippetSuffix = O.CompletionSnippetSuffix;
- if (S.Documentation == "")
+ // Don't accept documentation from bare forward declarations, if there is a
+ // definition and it didn't provide one. S is often an undocumented class,
+ // and O is a non-canonical forward decl preceded by an irrelevant comment.
+ if (S.Documentation == "" && !S.Definition)
S.Documentation = O.Documentation;
if (S.ReturnType == "")
S.ReturnType = O.ReturnType;
diff --git a/clangd/unittests/IndexTests.cpp b/clangd/unittests/IndexTests.cpp
index b3a5489..d4017c2 100644
--- a/clangd/unittests/IndexTests.cpp
+++ b/clangd/unittests/IndexTests.cpp
@@ -413,6 +413,16 @@
FileURI("unittest:///test2.cc"))))));
}
+TEST(MergeIndexTest, NonDocumentation) {
+ Symbol L, R;
+ L.ID = R.ID = SymbolID("x");
+ L.Definition.FileURI = "file:/x.h";
+ R.Documentation = "Forward declarations because x.h is too big to include";
+
+ Symbol M = mergeSymbol(L, R);
+ EXPECT_EQ(M.Documentation, "");
+}
+
MATCHER_P2(IncludeHeaderWithRef, IncludeHeader, References, "") {
return (arg.IncludeHeader == IncludeHeader) && (arg.References == References);
}
