Hover should report documentation about cquery HOT 15 CLOSED

This will probably require changes in the indexer so it indexes comments. It may also be possible to do try to find the cursor in an active code completion translation unit and lookup documentation from there.

from cquery.

+1

from cquery.

+1

from cquery.

So, I tried a quick hack to see how far I can get.

It turned out that with only a small change in the indexer.cc you can get pretty far:
src/indexer.cc | 17 ++++++++++-------

The idea is the prepend the documentation comment right before the existing hover text. Almost all of the changes look like:

-      var->def.hover = type_name;
+      var->def.hover = decl_cursor.get_comments() + "\n" + type_name;

It works, though the formatting may need to be improved.

One thing, that is kind of annoying, is the fact that only certain kind of comments reported. E.g. /* */ and ///. But it does not report any // comments that are often used for local variables, etc. And the reason for this is that ClangCursor::get_comments() uses clang_Cursor_getRawCommentText, which does not report this type of comments. The only related discussion I've found is here. It talks about using getRawCommentForDeclNoCache, but this is a method on ASTContext which cquery does not seem to use.

Anyone has ideas how to add support for all types of comments? Is it important at all? IMHO, it is useful for local declarations. All functions, methods and types usually use the supported Doxygen-style comments anyways.

from cquery.

Comment support is very useful! I'd like to know how clients will display them.

Emacs lsp-mode curently displays textDocument/hover responses via eldoc-documentation-function:

With comments spanning a lot of lines, this may need improving.

from cquery.

I'll try to submit a PR later today or tomorrow, so that others can have a look and experiment with it.

And yes, with comments spanning a lot of lines, some additional formatting to make them look nice may be required.

from cquery.

@romix Add a new field for comments instead of prepending/appending them to hover. Then the behavior can be controlled with some command line option / other knob as clients are not generally ready for the UI challenge..

from cquery.

@MaskRay Yes, that could be a good idea.

from cquery.

Yea, please add a new field instead of prepending to hover.

from cquery.

If it is a new field, where/how do I return it back to the client? With hover it was easy, as it is handled already.

from cquery.

src/messages/text_document_hover.cc:GetHoverForSymbol but I'm not sure how to access command line option / initializationOptions there

Filed feature requests for some editors.

from cquery.

@MaskRay @jacobdufault I created a PR #183, so that other can try it out, propose improvements, etc.

from cquery.

Created #187, which improves the formatting of comments in hover pop-ups

from cquery.

Updated https://github.com/jacobdufault/cquery/wiki

from cquery.

Hover reports documentation with cquery --enable-comments --language-server
See #187 for discussion.

from cquery.