Browse Source

Change all function documentation to be imperative.

pull/419/head
Lucas Hoffmann 12 years ago
parent
commit
a8370504d4
4 changed files with 17 additions and 19 deletions
  1. +5
    -5
      autoload/vundle.vim
  2. +2
    -2
      autoload/vundle/config.vim
  3. +7
    -9
      autoload/vundle/installer.vim
  4. +3
    -3
      autoload/vundle/scripts.vim

+ 5
- 5
autoload/vundle.vim View File

@ -14,8 +14,6 @@ com! -nargs=? -bang -complete=custom,vundle#scripts#complete PluginInstall
com! -nargs=? -bang -complete=custom,vundle#scripts#complete PluginSearch
\ call vundle#scripts#all('!' == '<bang>', <q-args>)
" FIXME this command is not well documented in doc/vundle.txt and seems to be
" equivalent to PluginSearch.
com! -nargs=? -bang -complete=custom,vundle#scripts#complete Plugins
\ call vundle#scripts#all('!' == '<bang>', <q-args>)
@ -59,9 +57,11 @@ if (has('signs'))
sign define Vu_helptags text=* texthl=Comment
endif
" Setup function to be called from the users vimrc file. It is not possible
" to do this automatically because when loading the vimrc file no plugins
" where loaded yet.
" Set up Vundle. This function has to be called from the users vimrc file.
" This will force Vim to source this file as a side effect which wil define
" the :Plugin command. After calling this function the user can use the
" :Plugin command in the vimrc. It is not possible to do this automatically
" because when loading the vimrc file no plugins where loaded yet.
func! vundle#rc(...) abort
let g:bundle_dir = len(a:000) > 0 ? expand(a:1, 1) : expand('$HOME/.vim/bundle', 1)
let g:updated_bundles = []


+ 2
- 2
autoload/vundle/config.vim View File

@ -165,8 +165,8 @@ let s:bundle = {}
" FIXME: This function is only called once and in most cases the return value
" is stored in the bundle object as obj.rtpath unmodfied. Is this necessary?
"
" A method of the bundle object returning the path inside the bundle directory
" where the plugin is cloned to.
" Return the absolute path to the directory inside the bundle directory
" (prefix) where thr bundle will be cloned.
"
" return -- the target location to clone this bundle to
func! s:bundle.path()


+ 7
- 9
autoload/vundle/installer.vim View File

@ -1,6 +1,5 @@
" This function is called by :PluginInstall. It will try to clone all new
" bundles given (or all bundles in g:bundles by default) to g:bundle_dir. If
" a:bang is 1 it will also update all plugins (git pull).
" Try to clone all new bundles given (or all bundles in g:bundles by default)
" to g:bundle_dir. If a:bang is 1 it will also update all plugins (git pull).
"
" bang -- 1 or 0
" ... -- any number of bundle specifications (seperate arguments)
@ -23,9 +22,8 @@ func! vundle#installer#new(bang, ...) abort
call vundle#config#require(bundles)
endf
" A function to iterate over all lines in a Vundle window and execute the
" given command for every line. It is used by the installation and cleaning
" functions.
" Iterate over all lines in a Vundle window and execute the given command for
" every line. Used by the installation and cleaning functions.
"
" bang -- not used (FIXME)
" cmd -- the (normal mode) command to execute for every line as a string
@ -61,7 +59,7 @@ func! s:process(bang, cmd)
echo 'Done! '.msg
endf
" Wrapper function to call another function in the different Vundle windows.
" Call another function in the different Vundle windows.
"
" func_name -- the function to call
" name -- the bundle name to call func_name for (string)
@ -363,9 +361,9 @@ func! g:shellesc_cd(cmd) abort
endif
endf
" Wrapper for system calls. This can be used to change the way system calls
" Make a system call. This can be used to change the way system calls
" are made during developing, without searching the whole code base for
" system() calls.
" actual system() calls.
"
" cmd -- the command passed to system() (string)
" return -- the return value from system()


+ 3
- 3
autoload/vundle/scripts.vim View File

@ -1,6 +1,6 @@
" This function searches the database from vim-script.org for a matching
" plugin. If no argument is given all plugins are listed. This function is
" used by the :Plugins and :PluginSearch commands.
" Searches the database from vim-script.org for a matching plugin. If no
" argument is given all plugins are listed. This function is used by the
" :Plugins and :PluginSearch commands.
"
" bang -- if 1 refresh the script name cache, if 0 don't
" ... -- a plugin name to search for (FIXME what about multible arguments, it


Loading…
Cancel
Save