documentation is bad comparing to ccls

[GopherJ]

Please describe the problem.
For hints on what information is helpful, see: https://clangd.llvm.org/troubleshooting.html

If you can, provide a minimal chunk of code that shows the problem (either inline, or attach it if larger).

Logs
Please attach the clangd stderr log if you can. (Usually available from the editor)
If possible, run with --log=verbose - note that the logs will include the contents of open files!
If this is a crash, try to put llvm-symbolizer on your PATH per the troubleshooting instructions.

System information
Output of clangd --version: clangd version 9.0.0-2~ubuntu18.04.2 (tags/RELEASE_900/final)
Editor/LSP plugin: coc.nvim, neovim
Operating system: LInux Mint 19.3

[njames93]

Care to elaborate. Any specific places you feel are lacking documentation. The website does a pretty decent job as it is right now.

[HighCommander4]

I think the reporter is referring to the way a function's Doxygen documentation is rendered in the posted screenshot (which I assume is of a hover window).

[GopherJ]

@HighCommander4 @njames93 Yes I mean the function documentation, I'm not sure it's clangd's error or coc.nvim's error

See also: clangd/coc-clangd#48

[HighCommander4]

Dupe of #529?

[kadircet]

This is a mixture of coc.nvim's markdown mocking and clangd's lack of doxygen comment parsing.

as mentioned in clangd/coc-clangd#48 (comment), we've changed our escaping to be less aggressive with recent versions of clangd. you can try with clangd-11 to have better results, which is available at https://releases.llvm.org/download.html#11.0.0.

though the doxygen comment processing is still lacking as @HighCommander4 pointed out.

[GopherJ]

@kadircet Hi, I justed tested and it's much more, it's not perfect yet but thanks for improving it.

I think the documentation is a little bit too wide, but this is maybe the json library's issue. The @param is not highlighted yet, I'll try some other colorscheme to see if it improves

[GopherJ]

@kadircet @HighCommander4 Let's only open #529 thanks for your replies