fix hover text

Author: xuhuanzy

crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_def_tags.rs

@@ -74,13 +74,13 @@ fn add_description_for_type_decl(
 ) {
     let mut description_text = String::new();
 
-    let comment = analyzer.comment.clone();
-    if let Some(description) = comment.get_description() {
-        let description = preprocess_description(&description.get_description_text(), None);
-        if !description.is_empty() {
-            description_text.push_str(&description);
-        }
-    }
+    // let comment = analyzer.comment.clone();
+    // if let Some(description) = comment.get_description() {
+    //     let description = preprocess_description(&description.get_description_text(), None);
+    //     if !description.is_empty() {
+    //         description_text.push_str(&description);
+    //     }
+    // }
 
     for description in descriptions {
         let description = preprocess_description(&description.get_description_text(), None);

crates/emmylua_ls/src/handlers/test/hover_function_test.rs

@@ -18,7 +18,7 @@ mod tests {
                 local <??>delete4 = delete3
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+                value: "```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a".to_string(),
             },
         ));
 
@@ -38,7 +38,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n删除\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+                value: "```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n删除\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a".to_string(),
             },
         ));
 
@@ -61,7 +61,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a\n\n\n".to_string(),
+                value: "```lua\nlocal function delete(a: number)\n  -> a: number\n\n```\n\n---\n\n@*param* `a` — 参数a\n\n\n\n@*return* `a`  — 返回值a".to_string(),
             },
         ));
     }
@@ -97,7 +97,7 @@ mod tests {
             local <??>local_b = local_a
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(method) Game:add(key: string, value: string)\n  -> ret: number\n\n```\n\n---\n\n说明\n\n@*param* `key` — 参数key\n\n@*param* `value` — 参数value\n\n\n\n@*return* `ret`  — 返回值\n\n\n" .to_string(),
+                value: "```lua\n(method) Game:add(key: string, value: string)\n  -> ret: number\n\n```\n\n---\n\n说明\n\n@*param* `key` — 参数key\n\n@*param* `value` — 参数value\n\n\n\n@*return* `ret`  — 返回值".to_string(),
             },
         ));
     }
@@ -122,7 +122,7 @@ mod tests {
                 local <??>event = test3.event
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(method) Test3:event(event: \"B\", key: string)\n```\n\n&nbsp;&nbsp;in class `Hover.Test3`\n\n---\n\n---\n\n```lua\n(method) Test3:event(event: \"A\", key: string)\n```\n".to_string(),
+                value: "```lua\n(method) Test3:event(event: \"B\", key: string)\n```\n\n&nbsp;&nbsp;in class `Hover.Test3`\n\n---\n\n---\n\n```lua\n(method) Test3:event(event: \"A\", key: string)\n```".to_string(),
             },
         ));
     }
@@ -160,7 +160,7 @@ mod tests {
                 ---@field event fun(self: self, event: "游戏-http返回"): Trigger
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(method) GameA:event(event_type: EventTypeA, ...: any)\n  -> Trigger\n\n```\n\n---\n\n注册引擎事件\n\n---\n\n```lua\n(method) GameA:event(event: \"游戏-初始化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-追帧完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-逻辑不同步\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-地形预设加载完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-结束\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-暂停\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-恢复\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-昼夜变化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-进入\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-离开\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-http返回\") -> Trigger\n```\n".to_string(),
+                value: "```lua\n(method) GameA:event(event_type: EventTypeA, ...: any)\n  -> Trigger\n\n```\n\n---\n\n注册引擎事件\n\n---\n\n```lua\n(method) GameA:event(event: \"游戏-初始化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-追帧完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-逻辑不同步\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-地形预设加载完成\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-结束\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-暂停\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-恢复\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-昼夜变化\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-进入\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"区域-离开\") -> Trigger\n```\n\n```lua\n(method) GameA:event(event: \"游戏-http返回\") -> Trigger\n```".to_string(),
             },
         ));
     }
@@ -179,7 +179,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nfunction ClosureTest.e(a: string, b: number)\n```\n\n---\n\n---\n\n```lua\n(field) ClosureTest.e(a: string, b: number)\n```\n".to_string(),
+                value: "```lua\nfunction ClosureTest.e(a: string, b: number)\n```\n\n---\n\n---\n\n```lua\n(field) ClosureTest.e(a: string, b: number)\n```".to_string(),
             },
         ));
     }
@@ -200,7 +200,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(method) T:func()\n```\n\n---\n\n注释注释\n".to_string(),
+                value: "```lua\n(method) T:func()\n```\n\n---\n\n注释注释".to_string(),
             },
         ));
     }
@@ -219,7 +219,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) a: string = \"a\"\n```\n\n---\n\n注释注释a\n".to_string(),
+                value: "```lua\n(field) a: string = \"a\"\n```\n\n---\n\n注释注释a".to_string(),
             },
         ));
     }
@@ -239,8 +239,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) T.func(self: string)\n```\n\n---\n\n注释注释\n"
-                    .to_string(),
+                value: "```lua\n(field) T.func(self: string)\n```\n\n---\n\n注释注释".to_string(),
             },
         ));
     }
@@ -261,7 +260,7 @@ mod tests {
                 }
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) T.func(a: (string|number))\n```\n\n---\n\n注释1\n\n注释2\n\n---\n\n```lua\n(field) T.func(a: string)\n```\n\n```lua\n(field) T.func(a: number)\n```\n"
+                value: "```lua\n(field) T.func(a: (string|number))\n```\n\n---\n\n注释1\n\n注释2\n\n---\n\n```lua\n(field) T.func(a: string)\n```\n\n```lua\n(field) T.func(a: number)\n```"
                     .to_string(),
             },
         ));
@@ -285,7 +284,7 @@ mod tests {
                 t.fu<??>nc(1)
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) T.func(a: number)\n```\n\n---\n\n注释2\n".to_string(),
+                value: "```lua\n(field) T.func(a: number)\n```\n\n---\n\n注释2".to_string(),
             },
         ));
     }
@@ -307,7 +306,7 @@ mod tests {
                 local ab<??>c = t.func
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) T.func(a: number)\n```\n\n---\n\n注释2\n\n注释1\n\n---\n\n```lua\n(field) T.func(a: string)\n```\n".to_string(),
+                value: "```lua\n(field) T.func(a: number)\n```\n\n---\n\n注释2\n\n注释1\n\n---\n\n```lua\n(field) T.func(a: string)\n```".to_string(),
             },
         ));
     }

crates/emmylua_ls/src/handlers/test/hover_test.rs

@@ -13,7 +13,9 @@ mod tests {
                 ---@field c boolean
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(class) A {\n    a: number,\n    b: string,\n    c: boolean,\n}\n```\n".to_string(),
+                value:
+                    "```lua\n(class) A {\n    a: number,\n    b: string,\n    c: boolean,\n}\n```"
+                        .to_string(),
             },
         ));
     }
@@ -35,7 +37,7 @@ mod tests {
                 m1.<??>x = {}
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) x: integer = 1\n```\n".to_string(),
+                value: "```lua\n(field) x: integer = 1\n```".to_string(),
             },
         ));
 
@@ -58,7 +60,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) right: Node\n```\n".to_string(),
+                value: "```lua\n(field) right: Node\n```".to_string(),
             },
         ));
 
@@ -80,7 +82,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nlocal node: Node1 {\n    x: number,\n}\n```\n".to_string(),
+                value: "```lua\nlocal node: Node1 {\n    x: number,\n}\n```".to_string(),
             },
         ));
     }
@@ -99,7 +101,7 @@ mod tests {
                 local d = a.<??>a
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) a: number?\n```\n".to_string(),
+                value: "```lua\n(field) a: number?\n```".to_string(),
             },
         ));
     }
@@ -114,7 +116,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\nlocal function f(a, b)\n```\n".to_string(),
+                value: "```lua\nlocal function f(a, b)\n```".to_string(),
             },
         ));
     }
@@ -133,7 +135,7 @@ mod tests {
                 data.pu<??>lse
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) pulse: number?\n```\n\n&nbsp;&nbsp;in class `Buff.AddData`\n\n---\n\n心跳周期\n".to_string(),
+                value: "```lua\n(field) pulse: number?\n```\n\n&nbsp;&nbsp;in class `Buff.AddData`\n\n---\n\n心跳周期".to_string(),
             },
         ));
     }
@@ -154,7 +156,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) _cfg: number\n```\n".to_string(),
+                value: "```lua\n(field) _cfg: number\n```".to_string(),
             },
         ));
 
@@ -176,7 +178,7 @@ mod tests {
                 end
             "#,
             VirtualHoverResult {
-                value: "\n```lua\n(field) _cfg: number\n```\n".to_string(),
+                value: "```lua\n(field) _cfg: number\n```".to_string(),
             },
         ));
     }
@@ -195,4 +197,19 @@ mod tests {
             },
         ));
     }
+
+    #[test]
+    fn test_class_desc() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        assert!(ws.check_hover(
+            r#"
+            ---A1
+            ---@class AB<??>C
+            ---A2
+            "#,
+            VirtualHoverResult {
+                value: "```lua\n(class) ABC\n```\n\n---\n\nA1".to_string(),
+            },
+        ));
+    }
 }