Skip to content

Enable user to use the plural form of @return #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
smt wants to merge 2 commits into from
Closed

Enable user to use the plural form of @return #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69bf113
Add option to enable @returns tag
smt Jun 3, 2015
6ffb1f6
Add documentation for the `g:jsdoc_return_plural` option
smt Jun 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Prompt for and add a type for the aforementioned `@return` tag.
**g:jsdoc_return_description** *default: 1*
Prompt for and add a description for the `@return` tag.

**g:jsdoc_return_plural** *default: 0*
Use the `@returns` tag instead of `@return`.

**g:jsdoc_default_mapping** *default: 1*
Set value to 0 to turn off default mapping of <C-l> :JsDoc<cr>

Expand Down
14 changes: 11 additions & 3 deletions autoload/jsdoc.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ endif
if !exists('g:jsdoc_return')
let g:jsdoc_return = 1
endif
" Set @return tag plurality
if !exists('g:jsdoc_return_plural')
let g:jsdoc_return_plural = 0
endif
" Prompt user for return description
if !exists('g:jsdoc_return_description')
let g:jsdoc_return_description = 1
Expand Down Expand Up @@ -154,8 +158,12 @@ function! jsdoc#insert()
endfor
endif
if g:jsdoc_return == 1
let l:returnTag = '@return'
if g:jsdoc_return_plural == 1
let l:returnTag = l:returnTag . 's'
endif
if g:jsdoc_allow_input_prompt == 1
let l:returnType = input('Return type (blank for no @return): ', '', 'custom,jsdoc#listDataTypes')
let l:returnType = input('Return type (blank for no ' . l:returnTag . '): ', '', 'custom,jsdoc#listDataTypes')
let l:returnDescription = ''
if l:returnType != ''
if g:jsdoc_return_description == 1
Expand All @@ -164,10 +172,10 @@ function! jsdoc#insert()
if l:returnDescription != ''
let l:returnDescription = ' ' . l:returnDescription
endif
call add(l:lines, l:space . ' * @return {' . l:returnType . '}' . l:returnDescription)
call add(l:lines, l:space . ' * ' . l:returnTag . ' {' . l:returnType . '}' . l:returnDescription)
endif
else
call add(l:lines, l:space . ' * @return {undefined}')
call add(l:lines, l:space . ' * ' . l:returnTag . ' {undefined}')
endif
endif
call add(l:lines, l:space . ' */')
Expand Down
5 changes: 5 additions & 0 deletions doc/jsdoc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ g:jsdoc_return_description *g:jsdoc_return_description*

Default value is '1'

g:jsdoc_return_plural *g:jsdoc_return_plural
Use the `@returns` tag instead of `@return`.

Default value is '0'

g:jsdoc_default_mapping *g:jsdoc_default_mapping*
Automatically map to <C-l>

Expand Down