================
@@ -118,8 +138,8 @@ class Document {
BulletList &addBulletList();
/// Doesn't contain any trailing newlines.
- /// We try to make the markdown human-readable, e.g. avoid extra escaping.
- /// At least one client (coc.nvim) displays the markdown verbatim!
----------------
emaxx-google wrote:
I think we should distinguish between the input documentation's syntax and the
client's rendering capabilities. The latter defines the syntax in which it
expects the data received from the server, and not that all input is forced to
be treated as if written in Markdown. As said, we're suspecting that source
comments in a lot of projects would be rendered incorrectly if they'd be all
interpreted as verbatim Markdown as a blanket decision.
So guarding this "no escaping" behavior by an option is one possibility, yes.
Another possible direction could be to decide based on the syntax used in the
comments - i.e., recognizing those distinctive comment syntaxes from
https://www.doxygen.nl/manual/docblocks.html ? (This latter option would be
nice as it'd provide reasonable behavior by default, although if necessary it
could still be combined with a server option.)
https://github.com/llvm/llvm-project/pull/140498
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
