Skip to content

Commit

Permalink
Update new options descriptions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Crystal-Spider committed Jul 16, 2024
1 parent 0e87ba5 commit 42ca52c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ This extension contributes the following settings:
Formats can include time as well.
Leave empty to disable.
Default: `""`
- `jsdoc-generator.emptyLineAfterHeader`:
Whether to prefer single line comments (`/** ... */`) whenever possible.
Default: `true`
- `jsdoc-generator.singleLineComments`:
Whether to add an empty line after the header (description, date, author).
Default: `false`
- `jsdoc-generator.includeTypes`:
Whether to include types into the generated JSDoc.
Default: `true`
Expand Down Expand Up @@ -190,6 +196,11 @@ Some non [everyday types](https://www.typescriptlang.org/docs/handbook/2/everyda

## Release Notes

### [2.2.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.2.0)

- [#23](https://github.com/Crystal-Spider/jsdoc-generator/pull/23), new options to create single line descriptions and to omit the empty line after descriptions.
- [#24](https://github.com/Crystal-Spider/jsdoc-generator/pull/24), placeholder for unknown type annotations (`any`s).

### [2.1.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.1.0)

- [#22](https://github.com/Crystal-Spider/jsdoc-generator/issues/22), changing how date tag format is handled.
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Automatic JSDoc generator for TypeScript and JavaScript.",
"publisher": "crystal-spider",
"icon": "jsdoc-generator.png",
"version": "2.1.0",
"version": "2.2.0",
"engines": {
"vscode": "^1.57.0"
},
Expand Down Expand Up @@ -73,12 +73,12 @@
"jsdoc-generator.emptyLineAfterHeader": {
"type": "boolean",
"default": "true",
"description": "Add empty line after header (description, date, author)."
"description": "Whether to add an empty line after the header (description, date, author)."
},
"jsdoc-generator.singleLineComments": {
"type": "boolean",
"default": "false",
"description": "Generate single line comments (/** ... */) instead of always multiple lines."
"description": "Whether to prefer single line comments (/** ... */) whenever possible."
},
"jsdoc-generator.includeTypes": {
"type": "boolean",
Expand Down

0 comments on commit 42ca52c

Please sign in to comment.