Skip to content

Commit

Permalink
docs: document jsdocIgnoreTags
Browse files Browse the repository at this point in the history
  • Loading branch information
homer0 committed Apr 9, 2024
1 parent 06dd9dc commit 9110382
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ A [Prettier](https://prettier.io) plugin to format [JSDoc](https://jsdoc.app) bl
- [Allow descriptions to be on different lines](#allow-descriptions-to-be-on-different-lines)
- [Ignore tags for consistent columns](#ignore-tags-for-consistent-columns)
- [Use an inline block for a single tag](#use-an-inline-block-for-a-single-tag)
- [Ignore specific tags](#ignore-specific-tags)
- [Extras](#extras)
- [Custom width](#custom-width)
- [Turn the plugin on and off](#turn-the-plugin-on-and-off)
Expand Down Expand Up @@ -829,6 +830,14 @@ Whether or not to use a single line JSDoc block when there\'s only one tag.
/** @type {string} */
```

##### Ignore specific tags

| Option | Type | Default |
| ----------------- | ----- | ------- |
| `jsdocIgnoreTags` | array | _empty_ |

A list of tags that should be ignored when formatting JSDoc comments.

#### Extras

##### Custom width
Expand Down

0 comments on commit 9110382

Please sign in to comment.