Improve rendering of alias/enum descriptions

Previously if an alias contained a class reference as one of its
variants, we would paste the class's description into the alias
description, and not display the class as one of the variants.

This fixes both of those issues.

Author: tommaisey

script/core/hover/description.lua

@@ -212,11 +212,15 @@ local function lookUpDocComments(source)
     return table.concat(lines, '\n')
 end
 
-local function tryDocClassComment(source)
+local function tryDocClassComment(source, types)
+    types = types or {
+        ['doc.class'] = true,
+        ['doc.alias'] = true,
+        ['doc.enum'] = true,
+    }
+
     for _, def in ipairs(vm.getDefs(source)) do
-        if def.type == 'doc.class'
-        or def.type == 'doc.alias'
-        or def.type == 'doc.enum' then
+        if types[def.type] then
             local comment = getBindComment(def)
             if comment then
                 return comment
@@ -236,31 +240,50 @@ local function buildEnumChunk(docType, name, uri)
     if not docType then
         return nil
     end
+    local concreteType = {
+        ['doc.type.string'] = true,
+        ['doc.type.integer'] = true,
+        ['doc.type.number'] = true,
+        ['doc.type.boolean'] = true,
+    }
+    local enumLike = {
+        ['doc.enum'] = true,
+        ['doc.alias'] = true
+    }
+
     local enums = {}
     local types = {}
     local lines = {}
-    for _, tp in ipairs(vm.getDefs(docType)) do
+
+    for i, tp in ipairs(vm.getDefs(docType)) do
         types[#types+1] = vm.getInfer(tp):view(guide.getUri(docType))
-        if tp.type == 'doc.type.string'
-        or tp.type == 'doc.type.integer'
-        or tp.type == 'doc.type.boolean'
-        or tp.type == 'doc.type.code' then
-            enums[#enums+1] = tp
-        end
-        local comment = tryDocClassComment(tp)
-        if comment then
-            for line in util.eachLine(comment) do
-                lines[#lines+1] = line
+
+        local ty = tp.type
+
+        if i == 1 and not concreteType[ty] then
+            local comment = tryDocClassComment(tp)
+
+            if comment then
+                for line in util.eachLine(comment) do
+                    lines[#lines+1] = line
+                end
             end
         end
+
+        if not enumLike[ty] then
+            enums[#enums+1] = tp
+        end
     end
-    if #enums == 0 then
+
+    if #enums == 0 or (#enums == 1 and (enums[1].comment == nil or enums[1].comment == "")) then
         return nil
     end
+
     if #lines > 0 and lines[#lines] ~= "" then
         lines[#lines+1] = ""
     end
     lines[#lines+1] = ('#### %s:'):format(name)
+
     for _, enum in ipairs(enums) do
         local suffix = (enum.default and ' (default)')
             or (enum.additional and ' (additional)')

test/crossfile/hover.lua

@@ -400,6 +400,33 @@ function f(x: string|"选项1"|"选项2")
 
 ---
 
+#### x:
+  - `string`
+  - `"选项1"` — 注释1
+  - `"选项2"` (default) — 注释2]]
+}
+
+TEST {
+    {
+        path = 'a.lua',
+        content = '',
+    },
+    {
+        path = 'b.lua',
+        content = [[
+            ---@param x
+            ---|   "选项1" # 注释1
+            ---| > "选项2" # 注释2
+            function <?f?>(x) end
+        ]]
+    },
+    hover = [[
+```lua
+function f(x: "选项1"|"选项2")
+```
+
+---
+
 #### x:
   - `"选项1"` — 注释1
   - `"选项2"` (default) — 注释2]]
@@ -690,6 +717,27 @@ function f()
 comment1
 comment2]]}
 
+TEST {{ path = 'a.lua', content = '', }, {
+    path = 'b.lua',
+    content = [[
+        ---@param a boolean|string # xxx
+        local function <?f?>(a)
+        end
+    ]]
+},
+    hover = [[
+```lua
+function f(a: boolean|string)
+```
+
+---
+
+@*param* `a` — xxx
+
+#### a:
+  - `boolean`
+  - `string`]]}
+
 TEST {{ path = 'a.lua', content = '', }, {
     path = 'b.lua',
     content = [[
@@ -710,6 +758,7 @@ function f(a: boolean)
 @*param* `a` — xxx
 
 #### a:
+  - `boolean`
   - `true` — ttt
   - `false` — fff]]}