[FR] Improve display of tooltips

[serg3295]

To improve the display of the function description on hover, can you provide support for the <br> tag in the ---@param line to enter a line breaks without adding spaces between lines?

[sumneko]

Maybe supports this:
---@param name type "line1\nline2"

[serg3295]

Looks good to me.
Is it will apply to ---comments and to ---@return as well,
or only to ---@param ?

[serg3295]

Additional line breaks suggestions

In the --Description section I use backslash \ for line breaks.
In the section --Return backslash also breaks the line. But not on the line ---@return
Is it possible to line breaks with the \ character (or in any other way) in the ---@return line?

--- This is description\
--- with line breaks
---@param par1 table @fist line of params
--- - list -> line1
--- - list -> line2
--- - list -> line3\
---text parameters
---@return table tbl @returns table:\
--- - field 1
--- - field 2\
---text
function linebreaks(par1) end                                                               

[sumneko]

Additional line breaks suggestions

In the --Description section I use backslash \ for line breaks.
In the section --Return backslash also breaks the line. But not on the line ---@return
Is it possible to line breaks with the \ character (or in any other way) in the ---@return line?

--- This is description\
--- with line breaks
---@param par1 table @fist line of params
--- - list -> line1
--- - list -> line2
--- - list -> line3\
---text parameters
---@return table tbl @returns table:\
--- - field 1
--- - field 2\
---text
function linebreaks(par1) end                                                               

The current rules of comments showing are already very complicated, and I don't want to further increase his complexity. Longer descriptions are best written in the description area, and the tail description of the annotation area is only used to write some shorter hints.

[sumneko]

To improve the display of the function description on hover, can you provide support for the
tag in the ---@param line to enter a line breaks without adding spaces between lines?

<br> is disabled by VSCode.

[serg3295]

The current rules of comments showing are already very complicated, and I don't want to further increase his complexity.

OK.