From 2c09275388d4c88ea26bf709132b8be4a9e342bc Mon Sep 17 00:00:00 2001
From: Yong He <yonghe@outlook.com>
Date: Thu, 30 Jun 2022 14:19:39 -0700
Subject: Language server: extract documentation from ordinary comments (#2308)

* Language server: improved documentation formatting.

* Extend doc extractor to search in ordinary comments.
Reuse language server instance between tests.

* Fix test case.

* Fix comment.

* Fix crash.

* Fix enum case doc extraction.

* Doc extractor fixes.

* Fix.

* Fix.

Co-authored-by: Yong He <yhe@nvidia.com>
---
 .../generic-func-type-arg.slang.expected.txt       |  1 -
 .../incomplete-inheritance.slang.expected.txt      |  1 -
 .../ordinary-comment-hover-info.slang              | 21 +++++++++++++
 .../ordinary-comment-hover-info.slang.expected.txt | 35 ++++++++++++++++++++++
 .../robustness-2.slang.expected.txt                |  2 +-
 .../robustness-3.slang.expected.txt                |  1 -
 tests/language-server/smoke.slang.expected.txt     |  3 +-
 7 files changed, 58 insertions(+), 6 deletions(-)
 create mode 100644 tests/language-server/ordinary-comment-hover-info.slang
 create mode 100644 tests/language-server/ordinary-comment-hover-info.slang.expected.txt

(limited to 'tests')

diff --git a/tests/language-server/generic-func-type-arg.slang.expected.txt b/tests/language-server/generic-func-type-arg.slang.expected.txt
index b8cae46b7..31375d1e4 100644
--- a/tests/language-server/generic-func-type-arg.slang.expected.txt
+++ b/tests/language-server/generic-func-type-arg.slang.expected.txt
@@ -6,7 +6,6 @@ struct MyType
 ```
 
 
-
 {REDACTED}.slang(2)
 
 
diff --git a/tests/language-server/incomplete-inheritance.slang.expected.txt b/tests/language-server/incomplete-inheritance.slang.expected.txt
index ceaf9104b..ec920b2eb 100644
--- a/tests/language-server/incomplete-inheritance.slang.expected.txt
+++ b/tests/language-server/incomplete-inheritance.slang.expected.txt
@@ -6,7 +6,6 @@ struct MyType
 ```
 
 
-
 {REDACTED}.slang(3)
 
 
diff --git a/tests/language-server/ordinary-comment-hover-info.slang b/tests/language-server/ordinary-comment-hover-info.slang
new file mode 100644
index 000000000..83ab4ff99
--- /dev/null
+++ b/tests/language-server/ordinary-comment-hover-info.slang
@@ -0,0 +1,21 @@
+//TEST:LANG_SERVER:
+//HOVER:8,7
+//HOVER:13,7
+//HOVER:20,6
+
+// #1: Ordindary comment for `value`.
+//
+int value;
+
+/* #2: Ordinary block comment for main func.
+   #3: This func doesn't return anything.
+*/
+void main()
+{
+}
+
+enum E
+{
+   Red, // #4 red color
+   Green, // #5 green color
+}
diff --git a/tests/language-server/ordinary-comment-hover-info.slang.expected.txt b/tests/language-server/ordinary-comment-hover-info.slang.expected.txt
new file mode 100644
index 000000000..d4fa0328a
--- /dev/null
+++ b/tests/language-server/ordinary-comment-hover-info.slang.expected.txt
@@ -0,0 +1,35 @@
+--------
+range: 7,4 - 7,9
+content:
+```
+int value
+```
+
+#1: Ordindary comment for `value`.  
+
+{REDACTED}.slang(8)
+
+--------
+range: 12,5 - 12,9
+content:
+```
+func main() -> void
+```
+
+ #2: Ordinary block comment for main func.  
+   #3: This func doesn't return anything.  
+
+{REDACTED}.slang(13)
+
+--------
+range: 19,3 - 19,8
+content:
+```
+E E.Green
+```
+
+#5 green color  
+
+{REDACTED}.slang(20)
+
+
diff --git a/tests/language-server/robustness-2.slang.expected.txt b/tests/language-server/robustness-2.slang.expected.txt
index 2236aea91..346f637c6 100644
--- a/tests/language-server/robustness-2.slang.expected.txt
+++ b/tests/language-server/robustness-2.slang.expected.txt
@@ -5,7 +5,7 @@ content:
 Kind Kind.Foo
 ```
 
-
+HOVER:15,6  
 
 {REDACTED}.slang(15)
 
diff --git a/tests/language-server/robustness-3.slang.expected.txt b/tests/language-server/robustness-3.slang.expected.txt
index 000ad6add..8dcd04228 100644
--- a/tests/language-server/robustness-3.slang.expected.txt
+++ b/tests/language-server/robustness-3.slang.expected.txt
@@ -6,7 +6,6 @@ int index
 ```
 
 
-
 {REDACTED}.slang(7)
 
 
diff --git a/tests/language-server/smoke.slang.expected.txt b/tests/language-server/smoke.slang.expected.txt
index aa0a2cd56..0560c2a2d 100644
--- a/tests/language-server/smoke.slang.expected.txt
+++ b/tests/language-server/smoke.slang.expected.txt
@@ -10,7 +10,6 @@ Pair.T Pair<Pair.T, Pair.U>.first
 ```
 
 
-
 {REDACTED}.slang(20)
 
 --------
@@ -18,7 +17,7 @@ activeParameter: 0
 activeSignature: 0
 func IFoo.getSum() -> int:
 
-Returns the sum of the contents.
+Returns the sum of the contents.  
 
 {REDACTED}.slang(10)
 
-- 
cgit v1.2.3