@@ -14,13 +14,17 @@ Neovim works since v2.1.0, but if something wrong, send me pull requests to fix
14
14
15
15
If you want use old version checkout [ 1.0.0] ( https://github.com/heavenshell/vim-jsdoc/releases/tag/1.0.0> ) .
16
16
17
+ ## Requirements
18
+
19
+ Node v12.x or above.
20
+
17
21
## Install
18
22
19
23
### Vim Plug
20
24
21
25
```
22
- Plug 'heavenshell/vim-jsdoc', {
23
- \ 'for': ['javascript', 'javascript.jsx','typescript'],
26
+ Plug 'heavenshell/vim-jsdoc', {
27
+ \ 'for': ['javascript', 'javascript.jsx','typescript'],
24
28
\ 'do': 'make install'
25
29
\}
26
30
```
@@ -94,7 +98,7 @@ Option |Default |Description
94
98
95
99
You can choose formatter from [ JsDoc] ( https://jsdoc.app/ ) , [ ESDoc] ( https://esdoc.org/ ) , [ TSDoc] ( https://github.com/microsoft/tsdoc ) .
96
100
97
- If you want to create your own template, see [ example template] ( https://github.com/heavenshell/ts-lehre/tree/master/examples ) .
101
+ If you want to create your own template, see [ example template] ( https://github.com/heavenshell/ts-lehre/tree/master/examples ) .
98
102
99
103
## Interactive input
100
104
@@ -107,21 +111,25 @@ See [snippet example template](./examples/snippet_template.js).
107
111
## Keymap
108
112
109
113
You can add following setting to .vimrc
114
+
110
115
``` vim
111
116
nmap <silent> <C-l> <Plug>(jsdoc)
112
117
```
113
118
114
119
Alternatively, you could add the following setting to your .vimrc to search for the last ` function ` declaration
115
120
and puts your jsdoc above it:
121
+
116
122
``` vim
117
123
nmap <silent> <C-l> ?function<cr>:noh<cr><Plug>(jsdoc)
118
124
```
119
125
120
126
## Thanks
127
+
121
128
- This plugin based on https://gist.github.com/3903772#file-jsdoc-vim written by [ NAKAMURA, Hisashi] ( https://gist.github.com/sunvisor )
122
129
123
130
- The idea of npm packages installation is from [ vim-lsp-settings] ( https://github.com/mattn/vim-lsp-settings ) .
124
131
Highly applicate [ @mattn ] ( https://github.com/mattn/ ) and all vim-lsp-settings contributors.
125
132
126
133
## LICENSE
134
+
127
135
New BSD LICENSE
0 commit comments