doxygen documentation is shown in hover window with escaped punctiation

[jsholmes]

I don't know if this is a coc issue or a coc-clangd issue, but when I get hover information about a symbol, the documentation is shown with escaped punctuation making it quite hard to read. See screenshot.

## versions

vim version: NVIM v0.5.0-dev
node version: v14.1.0
coc.nvim version: 0.0.78-57637bb44c
term: screen-256color
platform: linux

## Output channel: clangd log

I[14:23:11.272] clangd version 9.0.1-8+hrt1hrt9.1

[sam-mccall]

Its fundamentally a coc issue: it requests the markdown version of the hover card, but then doesn't unescape the text per markdown rules.

That said, much escaping is optional and latest clangd should be doing much less (though there are common cases where it can't be avoided)

[jsholmes]

Yeah... I'm working to get my codebase building with clang-10. I'm on clang-8 right now, so maybe that's causing a lot of the excess markdown.

[jsholmes]

well, clangd-10 still has ample excess markdown.

[sam-mccall]

I'm sure that's true, but do you have an example?

[jsholmes]

Same example, but for clangd-10 rather than 9.

[sam-mccall]

My mistake, the escaping changes didn't make the clangd-10 release :-(

It looks better at trunk, thought there are still a few backslashes we can't easily drop:

(The t%2 typo is bothering me, sorry about that...)

[sam-mccall]

The wrapping is still terrible, we do detect the hard breaks after the colons but this is a good example of where assuming short lines imply hard breaks would be a big win.
(Sometime between clangd 9 and 10 we stopped preserving line breaks verbatim)

[jsholmes]

Why did you guys stop preserving the line breaks? Seems like that could at least be an option.

[talk2drys]

is there a work around for this?.

[kadircet]

we've improved escaping recently. you can build clangd at head, or use a binary from our weekly releases

[talk2drys]

thanks @kadircet I tested it with the latest snapshot, and saw improvement. attached is the updated screenshot.

[Lythenas]

It looks like they don't want to fix this in coc (neoclide/coc.nvim#2308). I often use markdown in my doc comments so this is really annoying.

Is it possible to tell clangd to do no escaping at all?

[flw-cn]

@jsholmes You can try Plug “flw-cn/vim-markdown” which is a fork for plasticboy/vim-markdown and it automatically hides the backslash. see PR preservim/vim-markdown#515 to see exactly what it does.

[fannheyward]

coc.nvim has rework document highlights, neoclide/coc.nvim#2497, please upgrade your coc.nvim and try again.

[GopherJ]

I also have some documentation issue with clangd-9 and latest coc.nvim:

[fannheyward]

Latest clangd has improved a lot, close for now.