m-vim_plugins/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2025-11-08 09:53:47 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

update the NERDComment() doc

Browse Source
This commit is contained in:
Martin Grenfell
2012-01-02 21:08:24 +00:00
parent 006a151a43
commit 8f2af9a6d7
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/NERD_commenter.txt
View File

@@ -372,16 +372,14 @@ Here the multipart delimiters are /* and */ and the marker is *.
All of the NERD commenter mappings and menu items invoke a single function
which delegates the commenting work to other functions. This function is
public and has the prototype: >
function! NERDComment(isVisual, type)
function! NERDComment(mode, type)
<
The arguments to this function are simple:
- isVisual: if you wish to do any kind of visual comment then set this to
1 and the function will use the '< and '> marks to find the comment
boundries. If set to 0 then the function will operate on the current
line.
- mode: a character indicating the mode in which the comment is requested:
'n' for Normal mode, 'x' for Visual mode
- type: is used to specify what type of commenting operation is to be
performed, and it can be one of the following: "sexy", "invert",
"minimal", "toggle", "alignLeft", "alignBoth", "norm", "nested",
"minimal", "toggle", "alignLeft", "alignBoth", "comment", "nested",
"toEOL", "append", "insert", "uncomment", "yank"
For example, if you typed >