diff --git a/README.md b/README.md index 26be042e06..378b29332e 100644 --- a/README.md +++ b/README.md @@ -420,6 +420,7 @@ Quick Feature Summary * Go to declaration/definition (`GoTo`, etc.) * Semantic type information for identifiers (`GetType`) * Automatically fix certain errors (`FixIt`) +* View documentation comments for identifiers (`GetDoc`) ### C♯ @@ -429,11 +430,13 @@ Quick Feature Summary * Semantic type information for identifiers (`GetType`) * Automatically fix certain errors (`FixIt`) * Management of OmniSharp server instance +* View documentation comments for identifiers (`GetDoc`) ### Python 2 * Intelligent auto-completion * Go to declaration/definition (`GoTo`, etc.) +* View documentation comments for identifiers (`GetDoc`) ### Go @@ -445,6 +448,7 @@ Quick Feature Summary * Semantic auto-completion * Go to definition (`GoToDefinition`) * Semantic type information for identifiers (`GetType`) +* View documentation comments for identifiers (`GetDoc`) User Guide ---------- @@ -911,6 +915,18 @@ where after fixing one diagnostic, another fix-it is available. 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 Starts the semantic-engine-as-localhost-server for those semantic engines that diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt index e88eda4b02..c1d5272fb9 100644 --- a/doc/youcompleteme.txt +++ b/doc/youcompleteme.txt @@ -45,12 +45,13 @@ Contents ~ 6. The |GetType| subcommand 7. The |GetParent| subcommand 8. The |FixIt| subcommand - 9. The |StartServer| subcommand - 10. The |StopServer| subcommand - 11. The |RestartServer| subcommand - 12. The |ReloadSolution| subcommand - 13. The |GoToImplementation| subcommand - 14. The |GoToImplementationElseDeclaration| subcommand + 9. The |GetDoc| subcommand + 10. The |StartServer| subcommand + 11. The |StopServer| subcommand + 12. The |RestartServer| subcommand + 13. The |ReloadSolution| subcommand + 14. The |GoToImplementation| subcommand + 15. The |GoToImplementationElseDeclaration| subcommand 8. Options |youcompleteme-options| 1. The |g:ycm_min_num_of_chars_for_completion| 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.) - Semantic type information for identifiers (|GetType|) - Automatically fix certain errors (|FixIt|) +- View documentation comments for identifiers (|GetDoc|) ------------------------------------------------------------------------------- *youcompleteme-c* @@ -597,6 +599,7 @@ C♯ ~ - Semantic type information for identifiers (|GetType|) - Automatically fix certain errors (|FixIt|) - Management of OmniSharp server instance +- View documentation comments for identifiers (|GetDoc|) ------------------------------------------------------------------------------- *youcompleteme-python-2* @@ -604,6 +607,7 @@ Python 2 ~ - Intelligent auto-completion - Go to declaration/definition (|GoTo|, etc.) +- View documentation comments for identifiers (|GetDoc|) ------------------------------------------------------------------------------- *youcompleteme-go* @@ -619,6 +623,7 @@ TypeScript ~ - Semantic auto-completion - Go to definition (|GoToDefinition|) - Semantic type information for identifiers (|GetType|) +- View documentation comments for identifiers (|GetDoc|) =============================================================================== *youcompleteme-user-guide* @@ -1122,6 +1127,19 @@ is available. 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