WIP: Serialize decl comments and use them in GetHoverForSymbol #183
Conversation
|
How about adding a command line option / config to decide whether the |
| const std::string &detailed_name) { | ||
| // TODO: Properly format multi-line comments. | ||
| std::string hover_string = comments; | ||
| if (hover) |
There was a problem hiding this comment.
The unconditional newline may be undesired in Emacs lsp-mode and LanguageClient-neovim .
There was a problem hiding this comment.
Yeah, I'm planning to return two strings as a response for the hover request. One for the formatted comment and one for the actual description/signature.
Both returned strings are lsMarkedString strings, i.e. markup strings. The comment string should have the markup type "text". The description/signature string should have the markup type "c++" to be properly rendered.
|
As for a command line option / config to decide whether the comments field should be used: Yes, we could introduce such an option. On the other hand, the comments are stored just for declarations, not for anything else. So, it is not clear if it would significantly increase the index size. |
|
Merged with |
This is a work in progress to support indexing of comments and to add documentation for declarations when displaying the hover information.
This PR tries to address #29