Merge pull request #2888 from sparr/dont_strip_function_comment_trailing_newlines

Return markdown from getFunctionComment to temporarily preserve trailing newlines

Author: sumneko

changelog.md

@@ -3,6 +3,7 @@
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
 * `FIX` Fixed an issue preventing to set the locale to Japanese
+* `FIX` Preserve newlines between function comment and @see
 * `FIX` Accept storagePath option from client to resolve addon directory not found
 
 ## 3.11.0

script/core/hover/description.lua

@@ -336,7 +336,7 @@ local function tryDocFieldComment(source)
     end
 end
 
-local function getFunctionComment(source, raw)
+local function getFunctionCommentMarkdown(source, raw)
     local docGroup = source.bindDocs
     if not docGroup then
         return
@@ -393,11 +393,7 @@ local function getFunctionComment(source, raw)
     local enums = getBindEnums(source, docGroup)
     md:add('lua', enums)
 
-    local comment = md:string()
-    if comment == '' then
-        return nil
-    end
-    return comment
+    return md
 end
 
 ---@async
@@ -407,8 +403,7 @@ local function tryDocComment(source, raw)
         source = source.value
     end
     if source.type == 'function' then
-        local comment = getFunctionComment(source, raw)
-        md:add('md', comment)
+        md:add('md', getFunctionCommentMarkdown(source, raw))
         source = source.parent
     end
     local comment = lookUpDocComments(source)