jsdoc-region-tag

replace region tags with code samples

3.0.0
latest
Source
npm

Version published: last year

Weekly downloads: 9.4K; decreased by-14.09%

Maintainers: 2

Weekly downloads

Created: 5 years ago

Source

Region Tag JSDoc Plugin

Reads a samples directory, extracting samples between [START]/[STOP] tags, allowing these samples to be placed in JSDoc comments, like so:

/*
  * @example <caption>include:samples/document-snippets/cluster.js</caption>
  * region_tag:bigtable_delete_cluster
  */

Usage

npm i jsdoc-region-tag.

add the plugin to your .jsdoc.js.

module.exports = {
  plugins: [
    'jsdoc-region-tag'
  ]
}

Configuration

The environment varaible SAMPLES_DIRECTORY can be set, to set a samples directory other than ./samples.

License

Apache-2.0

Keywords

FAQs

What is jsdoc-region-tag?

Is jsdoc-region-tag popular?

Is jsdoc-region-tag well maintained?

Package last updated on 10 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

jsdoc-region-tag