Show doc comments in semantic completions

jckarter commented 11 years ago

Bleeding-edge versions of clang are able to parse and index doc comments alongside definitions, and it'd be cool if YouCompleteMe could display some part of the doc comment for the cuurently chosen semantic completion.

sethfowler commented 11 years ago

Just commenting to register my interest in this.

Valloric commented 11 years ago

This is a planned feature, yes.

oplatek commented 11 years ago

Very interested in this feature too! Btw. I would like to see this feature for Python. I know that Jedi supports it and sometimes the Scratch Preview show the docstring during using tab completition. But I would like to trigger opening preview window with docstring by standalone command of YCM. That would be really cool;) Just browsing the source code and be able to read the docstrings!

artofhuman commented 11 years ago

:+1:

ulikoehler commented 10 years ago

:+1:

jsholmes commented 10 years ago

:thumbsup:

mwatts15 commented 9 years ago

:+1:

puremourning commented 9 years ago

https://groups.google.com/forum/#!topic/ycm-users/QhY-LvqVDs0

the stuff displayed in the preview window comes from the 'detailed_info' field of ycmd's completion response
libclang does give us the documentation "brief" (http://clang.llvm.org/doxygen/group__CINDEX__CODE__COMPLET.html#ga32163145c7f0013e5f2ac7176a8ee0ed) and ycmd's clang_completer does actually read that out, and puts it in the completion response. however, it sends it in the completion response's 'extra_data' field (as key 'doc_string' )
clang_completer puts the full method signature in the 'detailed_info' field
for the python completer and the c-sharp completer (where the docs do appear), the doc string is part of the 'detailed_info' field of the completion response
AFAICT from a quick look, the Vim clent (YCM) does not read the 'doc_string' from the completion response in any circumstances
A very quick hack to add to doc string to the detailed_info field displays the doc in the preview window.

If you're desperate for this in advance of a proper PR, then you can check out this hack here which is what generated the gif in the user group: https://github.com/puremourning/YouCompleteMe/commit/72a7dca491b2cf58940bcdb46b5d71c43067100a

puremourning commented 9 years ago

Demo here

demo

ycm-core / YouCompleteMe

Show doc comments in semantic completions #106