hokein created this revision.
hokein added a reviewer: ilya-biryukov.
Herald added subscribers: usaxena95, kadircet, arphaman, jkorous, MaskRay.
Herald added a project: clang.
There is a regression from https://reviews.llvm.org/D68467. Unlike class
forward declarations, function ducomentation is written in the declaration in
headers, the function definition doesn't contain any documentation, cases like:
foo.h
// this is foo.
void foo();
foo.cc
void foo() {}
we should still show documentation from the foo declaration.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D69961
Files:
clang-tools-extra/clangd/index/Merge.cpp
clang-tools-extra/clangd/unittests/IndexTests.cpp
Index: clang-tools-extra/clangd/unittests/IndexTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/IndexTests.cpp
+++ clang-tools-extra/clangd/unittests/IndexTests.cpp
@@ -411,6 +411,7 @@
Symbol L, R;
L.ID = R.ID = SymbolID("x");
L.Definition.FileURI = "file:/x.h";
+ L.SymInfo.Kind = index::SymbolKind::Class;
R.Documentation = "Forward declarations because x.h is too big to include";
Symbol M = mergeSymbol(L, R);
Index: clang-tools-extra/clangd/index/Merge.cpp
===================================================================
--- clang-tools-extra/clangd/index/Merge.cpp
+++ clang-tools-extra/clangd/index/Merge.cpp
@@ -186,11 +186,16 @@
S.Signature = O.Signature;
if (S.CompletionSnippetSuffix == "")
S.CompletionSnippetSuffix = O.CompletionSnippetSuffix;
- // 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.Documentation == "") {
+ // Don't accept documentation from bare forward class 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.
+ bool IsClass = S.SymInfo.Kind == index::SymbolKind::Class ||
+ S.SymInfo.Kind == index::SymbolKind::Struct;
+ if (!IsClass || !S.Definition)
+ S.Documentation = O.Documentation;
+ }
if (S.ReturnType == "")
S.ReturnType = O.ReturnType;
if (S.Type == "")
Index: clang-tools-extra/clangd/unittests/IndexTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/IndexTests.cpp
+++ clang-tools-extra/clangd/unittests/IndexTests.cpp
@@ -411,6 +411,7 @@
Symbol L, R;
L.ID = R.ID = SymbolID("x");
L.Definition.FileURI = "file:/x.h";
+ L.SymInfo.Kind = index::SymbolKind::Class;
R.Documentation = "Forward declarations because x.h is too big to include";
Symbol M = mergeSymbol(L, R);
Index: clang-tools-extra/clangd/index/Merge.cpp
===================================================================
--- clang-tools-extra/clangd/index/Merge.cpp
+++ clang-tools-extra/clangd/index/Merge.cpp
@@ -186,11 +186,16 @@
S.Signature = O.Signature;
if (S.CompletionSnippetSuffix == "")
S.CompletionSnippetSuffix = O.CompletionSnippetSuffix;
- // 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.Documentation == "") {
+ // Don't accept documentation from bare forward class 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.
+ bool IsClass = S.SymInfo.Kind == index::SymbolKind::Class ||
+ S.SymInfo.Kind == index::SymbolKind::Struct;
+ if (!IsClass || !S.Definition)
+ S.Documentation = O.Documentation;
+ }
if (S.ReturnType == "")
S.ReturnType = O.ReturnType;
if (S.Type == "")
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
