Skip to content

Commit

Permalink
update --name-format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
75lb committed Oct 11, 2019
1 parent a5f46ba commit de46dbb
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Returns markdown documentation from jsdoc-annoted source code.
| [options.plugin] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | Use an installed package containing helper and/or partial overrides. |
| [options.helper] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | handlebars helper files to override or extend the default set. |
| [options.partial] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | handlebars partial files to override or extend the default set. |
| [options.name-format] | <code>string</code> | Format identifier names in the [code](http://daringfireball.net/projects/markdown/syntax#code) style, (i.e. format using backticks or `<code></code>`). |
| [options.name-format] | <code>string</code> | Format identifier names as code (i.e. wrap function/property/class etc names in backticks). |
| [options.no-gfm] | <code>boolean</code> | By default, dmd generates github-flavoured markdown. Not all markdown parsers render gfm correctly. If your generated docs look incorrect on sites other than Github (e.g. npmjs.org) try enabling this option to disable Github-specific syntax. |
| [options.separators] | <code>boolean</code> | Put `<hr>` breaks between identifiers. Improves readability on bulky docs. |
| [options.module-index-format] | <code>string</code> | none, grouped, table, dl. |
Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class JsdocToMarkdown {
* @param [options.plugin] {string|string[]} - Use an installed package containing helper and/or partial overrides.
* @param [options.helper] {string|string[]} - handlebars helper files to override or extend the default set.
* @param [options.partial] {string|string[]} - handlebars partial files to override or extend the default set.
* @param [options.name-format] {string} - Format identifier names in the [code](http://daringfireball.net/projects/markdown/syntax#code) style, (i.e. format using backticks or `<code></code>`).
* @param [options.name-format] {string} - Format identifier names as code (i.e. wrap function/property/class etc names in backticks).
* @param [options.no-gfm] {boolean} - By default, dmd generates github-flavoured markdown. Not all markdown parsers render gfm correctly. If your generated docs look incorrect on sites other than Github (e.g. npmjs.org) try enabling this option to disable Github-specific syntax.
* @param [options.separators] {boolean} - Put `<hr>` breaks between identifiers. Improves readability on bulky docs.
* @param [options.module-index-format] {string} - none, grouped, table, dl.
Expand Down
2 changes: 1 addition & 1 deletion lib/cli-data.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ const dmdDefinitions = [
alias: 'l',
description: 'Specifies the default language used in [bold]{@example} blocks (for syntax-highlighting purposes). In the default gfm mode, each [bold]{@example} is wrapped in a fenced-code block. Example usage: [bold]{--example-lang js}. Use the special value [bold]{none} for no specific language. While using this option, you can override the supplied language for any [bold]{@example} by specifying the [bold]{@lang} subtag, e.g [bold]{@example @lang hbs}. Specifying [bold]{@example @lang off} will disable code blocks for that example.'
},
{ name: 'name-format', type: Boolean, description: 'Format identifier names as code' },
{ name: 'name-format', type: Boolean, description: 'Format identifier names as code (i.e. wrap function/property/class etc names in backticks).' },
{
name: 'no-gfm',
type: Boolean,
Expand Down
34 changes: 17 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@
"array-back": "^4.0.0",
"command-line-tool": "^0.8.0",
"config-master": "^3.1.0",
"dmd": "^4.0.2",
"dmd": "^4.0.4",
"jsdoc-api": "^5.0.3",
"jsdoc-parse": "^4.0.1",
"walk-back": "^3.0.1"
},
"devDependencies": {
"coveralls": "^3.0.6",
"coveralls": "^3.0.7",
"test-runner": "^0.6.0"
},
"standard": {
Expand Down

0 comments on commit de46dbb

Please sign in to comment.