Auto merge of #1701 - puremourning:getdoc-readme, r=Valloric
Declare support for GetDoc subcommand Fixes https://github.com/Valloric/YouCompleteMe/issues/1653 This change: * updates the `README.md` and vim help * updates the `ycmd` submodule to latest master, which includes `GetDoc` subcommand <!-- Reviewable:start --> [<img src="https://reviewable.io/review_button.png" height=40 alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/1701) <!-- Reviewable:end -->
This commit is contained in:
commit
5a186275a5
16
README.md
16
README.md
@ -420,6 +420,7 @@ Quick Feature Summary
|
|||||||
* Go to declaration/definition (`GoTo`, etc.)
|
* Go to declaration/definition (`GoTo`, etc.)
|
||||||
* Semantic type information for identifiers (`GetType`)
|
* Semantic type information for identifiers (`GetType`)
|
||||||
* Automatically fix certain errors (`FixIt`)
|
* Automatically fix certain errors (`FixIt`)
|
||||||
|
* View documentation comments for identifiers (`GetDoc`)
|
||||||
|
|
||||||
### C♯
|
### C♯
|
||||||
|
|
||||||
@ -429,11 +430,13 @@ Quick Feature Summary
|
|||||||
* Semantic type information for identifiers (`GetType`)
|
* Semantic type information for identifiers (`GetType`)
|
||||||
* Automatically fix certain errors (`FixIt`)
|
* Automatically fix certain errors (`FixIt`)
|
||||||
* Management of OmniSharp server instance
|
* Management of OmniSharp server instance
|
||||||
|
* View documentation comments for identifiers (`GetDoc`)
|
||||||
|
|
||||||
### Python 2
|
### Python 2
|
||||||
|
|
||||||
* Intelligent auto-completion
|
* Intelligent auto-completion
|
||||||
* Go to declaration/definition (`GoTo`, etc.)
|
* Go to declaration/definition (`GoTo`, etc.)
|
||||||
|
* View documentation comments for identifiers (`GetDoc`)
|
||||||
|
|
||||||
### Go
|
### Go
|
||||||
|
|
||||||
@ -445,6 +448,7 @@ Quick Feature Summary
|
|||||||
* Semantic auto-completion
|
* Semantic auto-completion
|
||||||
* Go to definition (`GoToDefinition`)
|
* Go to definition (`GoToDefinition`)
|
||||||
* Semantic type information for identifiers (`GetType`)
|
* Semantic type information for identifiers (`GetType`)
|
||||||
|
* View documentation comments for identifiers (`GetDoc`)
|
||||||
|
|
||||||
User Guide
|
User Guide
|
||||||
----------
|
----------
|
||||||
@ -911,6 +915,18 @@ where after fixing one diagnostic, another fix-it is available.
|
|||||||
|
|
||||||
Supported in filetypes: `c, cpp, objc, objcpp, cs`
|
Supported in filetypes: `c, cpp, objc, objcpp, cs`
|
||||||
|
|
||||||
|
### The `GetDoc` subcommand
|
||||||
|
|
||||||
|
Displays the preview window populated with quick info about the identifier
|
||||||
|
under the cursor. This includes, depending on the language, things like:
|
||||||
|
|
||||||
|
* The type or declaration of identifier
|
||||||
|
* Doxygen/javadoc comments
|
||||||
|
* Python docstrings
|
||||||
|
* etc.
|
||||||
|
|
||||||
|
Supported in filetypes: `c, cpp, objc, objcpp, cs, python, typescript`
|
||||||
|
|
||||||
### The `StartServer` subcommand
|
### The `StartServer` subcommand
|
||||||
|
|
||||||
Starts the semantic-engine-as-localhost-server for those semantic engines that
|
Starts the semantic-engine-as-localhost-server for those semantic engines that
|
||||||
|
@ -45,12 +45,13 @@ Contents ~
|
|||||||
6. The |GetType| subcommand
|
6. The |GetType| subcommand
|
||||||
7. The |GetParent| subcommand
|
7. The |GetParent| subcommand
|
||||||
8. The |FixIt| subcommand
|
8. The |FixIt| subcommand
|
||||||
9. The |StartServer| subcommand
|
9. The |GetDoc| subcommand
|
||||||
10. The |StopServer| subcommand
|
10. The |StartServer| subcommand
|
||||||
11. The |RestartServer| subcommand
|
11. The |StopServer| subcommand
|
||||||
12. The |ReloadSolution| subcommand
|
12. The |RestartServer| subcommand
|
||||||
13. The |GoToImplementation| subcommand
|
13. The |ReloadSolution| subcommand
|
||||||
14. The |GoToImplementationElseDeclaration| subcommand
|
14. The |GoToImplementation| subcommand
|
||||||
|
15. The |GoToImplementationElseDeclaration| subcommand
|
||||||
8. Options |youcompleteme-options|
|
8. Options |youcompleteme-options|
|
||||||
1. The |g:ycm_min_num_of_chars_for_completion| option
|
1. The |g:ycm_min_num_of_chars_for_completion| option
|
||||||
2. The |g:ycm_min_num_identifier_candidate_chars| option
|
2. The |g:ycm_min_num_identifier_candidate_chars| option
|
||||||
@ -586,6 +587,7 @@ C-family languages (C, C++, Objective C, Objective C++) ~
|
|||||||
- Go to declaration/definition (|GoTo|, etc.)
|
- Go to declaration/definition (|GoTo|, etc.)
|
||||||
- Semantic type information for identifiers (|GetType|)
|
- Semantic type information for identifiers (|GetType|)
|
||||||
- Automatically fix certain errors (|FixIt|)
|
- Automatically fix certain errors (|FixIt|)
|
||||||
|
- View documentation comments for identifiers (|GetDoc|)
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
*youcompleteme-c*
|
*youcompleteme-c*
|
||||||
@ -597,6 +599,7 @@ C♯ ~
|
|||||||
- Semantic type information for identifiers (|GetType|)
|
- Semantic type information for identifiers (|GetType|)
|
||||||
- Automatically fix certain errors (|FixIt|)
|
- Automatically fix certain errors (|FixIt|)
|
||||||
- Management of OmniSharp server instance
|
- Management of OmniSharp server instance
|
||||||
|
- View documentation comments for identifiers (|GetDoc|)
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
*youcompleteme-python-2*
|
*youcompleteme-python-2*
|
||||||
@ -604,6 +607,7 @@ Python 2 ~
|
|||||||
|
|
||||||
- Intelligent auto-completion
|
- Intelligent auto-completion
|
||||||
- Go to declaration/definition (|GoTo|, etc.)
|
- Go to declaration/definition (|GoTo|, etc.)
|
||||||
|
- View documentation comments for identifiers (|GetDoc|)
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
*youcompleteme-go*
|
*youcompleteme-go*
|
||||||
@ -619,6 +623,7 @@ TypeScript ~
|
|||||||
- Semantic auto-completion
|
- Semantic auto-completion
|
||||||
- Go to definition (|GoToDefinition|)
|
- Go to definition (|GoToDefinition|)
|
||||||
- Semantic type information for identifiers (|GetType|)
|
- Semantic type information for identifiers (|GetType|)
|
||||||
|
- View documentation comments for identifiers (|GetDoc|)
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
*youcompleteme-user-guide*
|
*youcompleteme-user-guide*
|
||||||
@ -1122,6 +1127,19 @@ is available.
|
|||||||
|
|
||||||
Supported in filetypes: 'c, cpp, objc, objcpp, cs'
|
Supported in filetypes: 'c, cpp, objc, objcpp, cs'
|
||||||
|
|
||||||
|
-------------------------------------------------------------------------------
|
||||||
|
The *GetDoc* subcommand
|
||||||
|
|
||||||
|
Displays the preview window populated with quick info about the identifier
|
||||||
|
under the cursor. This includes, depending on the language, things like:
|
||||||
|
|
||||||
|
- The type or declaration of identifier
|
||||||
|
- Doxygen/javadoc comments
|
||||||
|
- Python docstrings
|
||||||
|
- etc.
|
||||||
|
|
||||||
|
Supported in filetypes: 'c, cpp, objc, objcpp, cs, python, typescript'
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
The *StartServer* subcommand
|
The *StartServer* subcommand
|
||||||
|
|
||||||
|
2
third_party/ycmd
vendored
2
third_party/ycmd
vendored
@ -1 +1 @@
|
|||||||
Subproject commit cffa7bb2ff7139490174f3134a536961a5eb0ddb
|
Subproject commit a52efde0bfcffc8025522a85d65fdae5650b2798
|
Loading…
Reference in New Issue
Block a user