vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updating vimdoc from readme

Browse Source
This commit is contained in:
Strahinja Val Markovic 2014-03-21 12:40:35 -07:00
parent 90e097efa4
commit 9d3258df19
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/youcompleteme.txt
View File

@ -1,4 +1,4 @@
*youcompleteme.txt* YouCompleteMe: a code-completion engine for Vim *youcompleteme* YouCompleteMe: a code-completion engine for Vim
=============================================================================== ===============================================================================
Contents ~ Contents ~
@ -30,11 +30,12 @@ Contents ~
8. YcmCompleter subcommands |youcompleteme-ycmcompleter-subcommands| 8. YcmCompleter subcommands |youcompleteme-ycmcompleter-subcommands|
1. The |GoToDeclaration| subcommand 1. The |GoToDeclaration| subcommand
2. The |GoToDefinition| subcommand 2. The |GoToDefinition| subcommand
3. The |GoToDefinitionElseDeclaration| subcommand 3. The |GoTo| subcommand
4. The |ClearCompilationFlagCache| subcommand 4. The |GoToImprecise| subcommand
5. The |StartServer| subcommand 5. The |ClearCompilationFlagCache| subcommand
6. The |StopServer| subcommand 6. The |StartServer| subcommand
7. The |RestartServer| subcommand 7. The |StopServer| subcommand
8. The |RestartServer| subcommand
9. Options |youcompleteme-options| 9. 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
@ -750,8 +751,8 @@ Python one and on the Clang completer if the currently active file is a
C/C++/Objective-C one. C/C++/Objective-C one.
You may also want to map the subcommands to something less verbose; for You may also want to map the subcommands to something less verbose; for
instance, 'nnoremap <leader>jd :YcmCompleter GoToDefinitionElseDeclaration<CR>' instance, 'nnoremap <leader>jd :YcmCompleter GoTo<CR>' maps the '<leader>jd'
maps the '<leader>jd' sequence to the longer subcommand invocation. sequence to the longer subcommand invocation.
The various 'GoTo*' subcommands add entries to Vim's 'jumplist' so you can use The various 'GoTo*' subcommands add entries to Vim's 'jumplist' so you can use
'CTRL-O' to jump back to where you where before invoking the command (and 'CTRL-O' to jump back to where you where before invoking the command (and
@ -777,14 +778,29 @@ including with '#include' directives (directly or indirectly) in that file.
Supported in filetypes: 'c, cpp, objc, objcpp, python, cs' Supported in filetypes: 'c, cpp, objc, objcpp, python, cs'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *GoToDefinitionElseDeclaration* subcommand The *GoTo* subcommand
Looks up the symbol under the cursor and jumps to its definition if possible; This command tries to perform the "most sensible" GoTo operation it can.
if the definition is not accessible from the current translation unit, jumps to Currently, this means that it tries to look up the symbol under the cursor and
the symbol's declaration. jumps to its definition if possible; if the definition is not accessible from
the current translation unit, jumps to the symbol's declaration.
Supported in filetypes: 'c, cpp, objc, objcpp, python, cs' Supported in filetypes: 'c, cpp, objc, objcpp, python, cs'
-------------------------------------------------------------------------------
The *GoToImprecise* subcommand
WARNING: This command trades correctness for speed!
Same as the |GoTo| command except that it doesn't recompile the file with
libclang before looking up nodes in the AST. This can be very useful when
you're editing files that take long to compile but you know that you haven't
made any changes since the last parse that would lead to incorrect jumps. When
you're just browsing around your codebase, this command can spare you quite a
bit of latency.
Supported in filetypes: 'c, cpp, objc, objcpp'
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
The *ClearCompilationFlagCache* subcommand The *ClearCompilationFlagCache* subcommand
@ -934,7 +950,8 @@ Default: '[see next line]'
\ 'unite' : 1, \ 'unite' : 1,
\ 'text' : 1, \ 'text' : 1,
\ 'vimwiki' : 1, \ 'vimwiki' : 1,
\ 'pandoc' : 1 \ 'pandoc' : 1,
\ 'mail' : 1
\} \}
< <
------------------------------------------------------------------------------- -------------------------------------------------------------------------------