From 42ca52c648aad06b60cfb7bd1a260954ff3fdeb5 Mon Sep 17 00:00:00 2001 From: Crystal Spider Date: Tue, 16 Jul 2024 19:12:11 +0200 Subject: [PATCH] Update new options descriptions. --- README.md | 11 +++++++++++ package.json | 6 +++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0bf2d23..c0d1308 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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. diff --git a/package.json b/package.json index 7b6ce51..33ad9ef 100644 --- a/package.json +++ b/package.json @@ -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" }, @@ -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",