<commit_before>*jsdoc.txt*	Generate JsDoc to your JavaScript code.

Version: 0.0.6
Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
Modifyed: <NAME> <<EMAIL>>
Repository: http://github.com/heavenshell/vim-jsdoc/
License: BSD, see LICENSE for more details.

==============================================================================
CONTENTS					*jsdoc-vim-contents*

Introduction		|jsdoc-introduction|
Install			|jsdoc-install|
Tutorial		|jsdoc-tutorial|
Variables		|jsdoc-variables|

==============================================================================
INTRODUCTION					*jsdoc-vim-introduction*

|jsdoc| is a generater of JsDoc.

- This plugin based on https://gist.github.com/3903772#file-jsdoc-vim
  written by NAKAMURA, Hisashi(https://gist.github.com/sunvisor)

==============================================================================
INSTALL						*jsdoc-vim-install*

Install the distributed files into Vim runtime directory which is usually
~/.vim/, or $HOME/vimfiles on Windows.

If you install pathogen that provided from Tim Pope, you should extract the
file into 'bundle' directory.

==============================================================================
TUTORIAL					*jsdoc-vim-tutorial*

Define function to your code.
>
  function Foo(arg1, arg2) {
  }

  var obj = {
    foo: function (arg1, arg2) {
    }
  };
<
  Set cursor on `function` line and type following.
>
  :JsDoc
<
  Then JsDoc put above `function` line.
>
  /**
   * foo
   * @param arg1
   * @param arg2
   */
  function foo(arg1, arg2) {
  }

  var obj = {
    /**
     * foo
     * @param arg1
     * @param arg2
     */
    foo: function (arg1, arg2) {
    }
  };
<

==============================================================================
VARIABLES					*jsdoc-vim-variables*

g:jsdoc_additional_descriptions		*g:jsdoc_additional_descriptions*
		If g:jsdoc_input_description is '1' @function and @name
		append to JsDoc.

		Default value is '0'

g:jsdoc_input_description		*g:jsdoc_input_description*
		If g:jsdoc_input_description is '1' Prompt for a function
		description.

		Default value is '1'

g:jsdoc_allow_input_prompt		*g:jsdoc_allow_input_prompt*
		Allow prompt for a value for `@param`, `@return`
		add it to the JsDoc block.
		If prompt not allowed, only `@param`, `@return` add to the
		JsDoc.
		This variables affects to g:jsdoc_return_type and
		g:jsdoc_return_description.

		Default value is '0'

g:jsdoc_return				*g:jsdoc_return*
		Add the `@return` tag.

		Default value is '1'

g:jsdoc_return_type			*g:jsdoc_return_type*
		Prompt for and add a type for the aforementioned `@return` tag.

		Default value is '1'

g:jsdoc_return_description		*g:jsdoc_return_description*
		Prompt for and add a description for the `@return` tag.

		Default value is '1'

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

		Default value is '1'

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

		Default value is '1'

g:jsdoc_access_descriptions		*g:jsdoc_access_descriptions*

		Set value to 1 to turn on access tags like
		@access <private|public>`
		Set value to 2 to turn on access tags like `@<private|public>` 

		Default value is '0'

g:jsdoc_underscore_private		*g:jsdoc_underscore_private*

		Set value to 1 to turn on detecting underscore starting
		functions as private convention

		Default value is '0'

==============================================================================
CHANGELOG					*jsdoc-changelog*
2015-01-15
- Add g:jsdoc_access_descriptions to set access tags.
- Add g:jsdoc_underscore_private to set underscore starting function as
  private.
  (thx @ryanoasis)

2014-06-05
- Add {undefined} as a default type of @return.
  (thx @verkholantsev)

2013-07-07<commit_msg>Fix g:jsdoc_default_mapping duprication.<commit_after>*jsdoc.txt*	Generate JsDoc to your JavaScript code.

Version: 0.0.6
Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
Modifyed: <NAME> <<EMAIL>>
Repository: http://github.com/heavenshell/vim-jsdoc/
License: BSD, see LICENSE for more details.

==============================================================================
CONTENTS					*jsdoc-vim-contents*

Introduction		|jsdoc-introduction|
Install			|jsdoc-install|
Tutorial		|jsdoc-tutorial|
Variables		|jsdoc-variables|

==============================================================================
INTRODUCTION					*jsdoc-vim-introduction*

|jsdoc| is a generater of JsDoc.

- This plugin based on https://gist.github.com/3903772#file-jsdoc-vim
  written by NAKAMURA, Hisashi(https://gist.github.com/sunvisor)

==============================================================================
INSTALL						*jsdoc-vim-install*

Install the distributed files into Vim runtime directory which is usually
~/.vim/, or $HOME/vimfiles on Windows.

If you install pathogen that provided from Tim Pope, you should extract the
file into 'bundle' directory.

==============================================================================
TUTORIAL					*jsdoc-vim-tutorial*

Define function to your code.
>
  function Foo(arg1, arg2) {
  }

  var obj = {
    foo: function (arg1, arg2) {
    }
  };
<
  Set cursor on `function` line and type following.
>
  :JsDoc
<
  Then JsDoc put above `function` line.
>
  /**
   * foo
   * @param arg1
   * @param arg2
   */
  function foo(arg1, arg2) {
  }

  var obj = {
    /**
     * foo
     * @param arg1
     * @param arg2
     */
    foo: function (arg1, arg2) {
    }
  };
<

==============================================================================
VARIABLES					*jsdoc-vim-variables*

g:jsdoc_additional_descriptions		*g:jsdoc_additional_descriptions*
		If g:jsdoc_input_description is '1' @function and @name
		append to JsDoc.

		Default value is '0'

g:jsdoc_input_description		*g:jsdoc_input_description*
		If g:jsdoc_input_description is '1' Prompt for a function
		description.

		Default value is '1'

g:jsdoc_allow_input_prompt		*g:jsdoc_allow_input_prompt*
		Allow prompt for a value for `@param`, `@return`
		add it to the JsDoc block.
		If prompt not allowed, only `@param`, `@return` add to the
		JsDoc.
		This variables affects to g:jsdoc_return_type and
		g:jsdoc_return_description.

		Default value is '0'

g:jsdoc_return				*g:jsdoc_return*
		Add the `@return` tag.

		Default value is '1'

g:jsdoc_return_type			*g:jsdoc_return_type*
		Prompt for and add a type for the aforementioned `@return` tag.

		Default value is '1'

g:jsdoc_return_description		*g:jsdoc_return_description*
		Prompt for and add a description for the `@return` tag.

		Default value is '1'

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

		Default value is '1'

g:jsdoc_access_descriptions		*g:jsdoc_access_descriptions*

		Set value to 1 to turn on access tags like
		@access <private|public>`
		Set value to 2 to turn on access tags like `@<private|public>`

		Default value is '0'

g:jsdoc_underscore_private		*g:jsdoc_underscore_private*

		Set value to 1 to turn on detecting underscore starting
		functions as private convention

		Default value is '0'

g:jsdoc_allow_shorthand			*g:jsdoc_allow_shorthand*

		Set value to 1 to allow ECMAScript6 shorthand syntax.

		Default value is '0'


==============================================================================
CHANGELOG					*jsdoc-changelog*
2015-01-16
- Add g:jsdoc_allow_shorthand to allow ECMAScript6 shorthand syntax.

2015-01-15
- Add g:jsdoc_access_descriptions to set access tags.
- Add g:jsdoc_underscore_private to set underscore starting function as
  private.
  (thx @ryanoasis)

2014-06-05
- Add {undefined} as a default type of @return.
  (thx @verkholantsev)

2013-07-07
{'fraction_non_alphanumeric': 0.20292670292670292, 'fraction_numerical': 0.017223517223517223, 'mean_word_length': 4.423455056179775, 'pattern_counts': {'":': 0, '<': 24, '<?xml version=': 0, '>': 24, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1246899', 'n_tokens_mistral': 2762, 'n_tokens_neox': 2453, 'n_words': 718}