kadircet created this revision.
kadircet added reviewers: sammccall, ilya-biryukov.
Herald added subscribers: cfe-commits, usaxena95, arphaman, jkorous, MaskRay.
Herald added a project: clang.
Moves type/returntype into its own line as it is more readable in cases
where the type is long.
Also gives parameter lists a heading, `Parameters:` to make them stand out.
Leaves the `right arrow` instead of `Returns: ` before Return Type to make
output more symmetric.
function foo
Returns: ret_type
Parameters:
- int x
vs
function foo
🡺 ret_type
Parameters:
- int x
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D72623
Files:
clang-tools-extra/clangd/Hover.cpp
clang-tools-extra/clangd/test/hover.test
clang-tools-extra/clangd/unittests/HoverTests.cpp
Index: clang-tools-extra/clangd/unittests/HoverTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/HoverTests.cpp
+++ clang-tools-extra/clangd/unittests/HoverTests.cpp
@@ -1769,8 +1769,10 @@
HI.NamespaceScope = "ns::";
HI.Definition = "ret_type foo(params) {}";
},
- R"(function foo → ret_type
+ R"(function foo
+🡺 ret_type
+Parameters:
-
- type
- type foo
@@ -1788,8 +1790,9 @@
HI.Type = "type";
HI.Definition = "def";
},
- R"(variable foo : type
+ R"(variable foo
+Type: type
Value = value
// In test::bar
Index: clang-tools-extra/clangd/test/hover.test
===================================================================
--- clang-tools-extra/clangd/test/hover.test
+++ clang-tools-extra/clangd/test/hover.test
@@ -9,7 +9,7 @@
# CHECK-NEXT: "result": {
# CHECK-NEXT: "contents": {
# CHECK-NEXT: "kind": "plaintext",
-# CHECK-NEXT: "value": "function foo → void\n\n\nvoid foo()"
+# CHECK-NEXT: "value": "function foo\n\n🡺 void\n\nvoid foo()"
# CHECK-NEXT: },
# CHECK-NEXT: "range": {
# CHECK-NEXT: "end": {
Index: clang-tools-extra/clangd/Hover.cpp
===================================================================
--- clang-tools-extra/clangd/Hover.cpp
+++ clang-tools-extra/clangd/Hover.cpp
@@ -518,11 +518,11 @@
markup::Document HoverInfo::present() const {
markup::Document Output;
// Header contains a text of the form:
- // variable `var` : `int`
+ // variable `var`
//
// class `X`
//
- // function `foo` → `int`
+ // function `foo`
markup::Paragraph &Header = Output.addParagraph();
if (Name.empty()) {
// User is hovering over an expression, we only have Type and Value set.
@@ -542,27 +542,29 @@
Header.appendText(index::getSymbolKindString(Kind));
Header.appendCode(Name);
- if (ReturnType) {
- Header.appendText("→");
- Header.appendCode(*ReturnType);
- } else if (Type) {
- Header.appendText(":");
- Header.appendCode(*Type);
- }
// Put a linebreak after header to increase readability.
Output.addRuler();
- // For functions we display signature in a list form, e.g.:
- // - `bool param1`
- // - `int param2 = 5`
- if (Parameters && !Parameters->empty()) {
- markup::BulletList &L = Output.addBulletList();
- for (const auto &Param : *Parameters) {
- std::string Buffer;
- llvm::raw_string_ostream OS(Buffer);
- OS << Param;
- L.addItem().addParagraph().appendCode(std::move(OS.str()));
+ // Print Types on their own lines to reduce chances of getting line-wrapped by
+ // editor, as they might be long.
+ if (ReturnType) {
+ // For functions we display signature in a list form, e.g.:
+ // Generates `x` from:
+ // - `bool param1`
+ // - `int param2 = 5`
+ Output.addParagraph().appendText("🡺").appendCode(*ReturnType);
+ if (Parameters && !Parameters->empty()) {
+ Output.addParagraph().appendText("Parameters:");
+ markup::BulletList &L = Output.addBulletList();
+ for (const auto &Param : *Parameters) {
+ std::string Buffer;
+ llvm::raw_string_ostream OS(Buffer);
+ OS << Param;
+ L.addItem().addParagraph().appendCode(std::move(OS.str()));
+ }
}
+ } else if (Type) {
+ Output.addParagraph().appendText("Type: ").appendCode(*Type);
}
if (Value) {
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
