Skip to content

Fix readme markdown formatting (escape pipes) #76

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

Merged
merged 1 commit into from
May 5, 2018
Merged

Fix readme markdown formatting (escape pipes) #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Option | Default | Description
**g:jsdoc_return** | 1 | Add the `@return` tag.
**g:jsdoc_return_type** | 1 | Prompt for and add a type for the aforementioned `@return` tag.
**g:jsdoc_return_description** | 1 | Prompt for and add a description for the `@return` tag.
**g:jsdoc_access_descriptions** | 0 | 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>`
**g:jsdoc_access_descriptions** | 0 | 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>`
**g:jsdoc_underscore_private** | 0 | Set value to 1 to turn on detecting underscore starting functions as private convention
**g:jsdoc_allow_shorthand** | 0 | Set value to 1 to allow ECMAScript6 shorthand syntax. Since ver `0.5.0` deprecated. Use `g:jsdoc_enable_es6` instead.
**g:jsdoc_param_description_separator** | ' ' | Characters used to separate `@param` name and description.
**g:jsdoc_custom_args_hook** | {} | Override default type and description. See help more detail.
**g:jsdoc_custom_args_regex_only** | 0 | When using `custom_args_hook`, only match against regexes
**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_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
Expand Down