Merge branch 'feature_user_defined_tags'

Author: heavenshell

README.md

@@ -37,6 +37,7 @@ Option                                  | Default | Description
 **g:jsdoc_type_hook**                   | {}      | Allow to insert default description depending on the type.
 **g:jsdoc_enable_es6**                  | 0       | Enable to use ECMAScript6's Shorthand function, Arrow function.
 **g:jsdoc_tags**                        | see :h  | Allow use of alternate tags (the ones that support synonyms) per JSDoc documentation. Can be changed on a per tag basis, for example: `let g:jsdoc_tags = {} | let g:jsdoc_tags['param'] = 'arg'`
+**g:jsdoc_user_defined_tags**           | {}     | Allow use of `user_defined_tags`.
 
 ## Keymap
 Since version `0.3`, `g:jsdoc_default_mapping` was removed.

autoload/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <[email protected]>
-" Version:  0.10.1
+" Version:  0.11.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.
@@ -29,6 +29,10 @@ let g:jsdoc_type_hook = exists('g:jsdoc_type_hook')
       \ ? g:jsdoc_type_hook
       \ : {}
 
+let g:jsdoc_user_defined_tags = exists('g:jsdoc_user_defined_tags')
+      \ ? g:jsdoc_user_defined_tags
+      \ : {}
+
 " Default tag names
 "   @returns      (synonyms: @return)
 "   @function     (synonyms: @func, @method)
@@ -402,6 +406,11 @@ function! jsdoc#insert() abort
       call add(l:lines, l:space . ' * @static')
     endif
 
+    " Add user defined tags.
+    for t in keys(g:jsdoc_user_defined_tags)
+      call add(l:lines, l:space . ' * ' . t . ' ' . g:jsdoc_user_defined_tags[t])
+    endfor
+
     let l:hook = keys(g:jsdoc_custom_args_hook)
     for l:arg in l:args
       let s:candidate_type = ''

doc/jsdoc.txt

@@ -1,6 +1,6 @@
 *jsdoc.txt*	Generate JSDoc to your JavaScript code.
 
-Version: 0.10.1
+Version: 0.11.0
 Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 Modifyed: Shinya Ohynagi <[email protected]>
 Repository: http://github.com/heavenshell/vim-jsdoc/
@@ -277,8 +277,33 @@ g:jsdoc_tags						*g:jsdoc_tags*
 >
 		Can be changed on a per tag basis, for example: let g:jsdoc_tags = {} | let g:jsdoc_tags['param'] = 'arg'
 
+g:jsdoc_user_defined_tags			*g:jsdoc_user_defined_tags*
+		Allow use of insert custom tags.
+		Default value is '{}'
+
+		If you set following setting to .vimrc or _vimrc.
+>
+		let g:jsdoc_user_defined_tags = {
+		\ '@author': 'Foo',
+		\ '@date': strftime('%Y-%m-%d'),
+		\}
+>
+		/**
+		 * foo
+		 *
+		 * @author Foo
+		 * @date 2016-09-11
+		 * @param {} arg1
+		 * @param {} arg2
+		 */
+		function foo(arg1, arg2) {
+		}
+>
 ==============================================================================
 CHANGELOG					*jsdoc-changelog*
+2016-09-11
+- Add g:jsdoc_user_defined_tags option for insert custom tags.
+
 2016-09-11
 - Fix private, public bug.
 

ftplugin/javascript/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <[email protected]>
-" Version:  0.10.1
+" Version:  0.11.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.

ftplugin/typescript/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <[email protected]>
-" Version:  0.10.1
+" Version:  0.11.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.