nerdtree

A tree explorer plugin for vim.
Index Commits Files Refs
commit a854feeb1ef728e4fd7f94912a9b85a8a5243d0c
parent cbb0a8698fa02a4fc7b3a003db3fde9b78f38ccc
Author: marty <martin_grenfell@msn.com>
Date:   Wed,  2 Sep 2009 22:07:23 +1200

comment Path#str()

Diffstat:
Mplugin/NERD_tree.vim | 19++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/plugin/NERD_tree.vim b/plugin/NERD_tree.vim
@@ -2191,7 +2191,24 @@ endfunction
 
 "FUNCTION: Path.str() {{{3
 "
-"Gets the actual string path that this obj represents.
+"Returns a string representation of this Path
+"
+"Takes an optional dictionary param to specify how the output should be
+"formatted.
+"
+"The dict may have the following keys:
+"  'format'
+"  'escape'
+"
+"The 'format' key may have a value of:
+"  'Cd' - a string to be used with the :cd command
+"  'Edit' - a string to be used with :e :sp :new :tabedit etc
+"  'OS' - a string to be used with shell commands
+"
+"If not specified, a generic unix style path string will be returned
+"
+"The 'escape' key, if specified will cause the output to be escaped with
+"shellescape()
 function! s:Path.str(...)
     let options = a:0 ? a:1 : {}
     let toReturn = ""