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

1. npm i jsdoc-region-tag.

2. 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

Changelog

3.0.0 (2023-08-10)

⚠ BREAKING CHANGES

• upgrade to Node 14 (#126)

Miscellaneous Chores

• Upgrade to Node 14 (#126) (76629d1)

2.0.1 (2022-08-23)

Bug Fixes

• remove pip install statements (#1546) (#111) (ea755f0)

2.0.0 (2022-05-20)

⚠ BREAKING CHANGES

• update library to use Node 12 (#107)

Build System

• update library to use Node 12 (#107) (5b51796)

1.3.1 (2021-08-11)

Bug Fixes

• build: migrate to using main branch (#79) (5050615)

1.3.0 (2021-07-08)

Features

• classdesc can also contain link (#74) (e57b3ad)

1.2.0 (2021-07-07)

Features

• replace relative URL with cloud.google.com (#72) (212febc)

1.1.0 (2021-06-10)

Features

• add gcf-owl-bot[bot] to ignoreAuthors (#56) (9e3649a)

1.0.6 (2020-09-02)

Bug Fixes

• main was pointing to old location (#33) (46be7f8)

1.0.5 (2020-08-29)

Bug Fixes

• move system and samples test from Node 10 to Node 12 (#30) (0cfc38b)

1.0.4 (2020-01-09)

Bug Fixes

• tag issue of undefined (#11) (adf52c5)

1.0.3 (2019-11-21)

Bug Fixes

• node_modules can have folders with .js extension (#3) (dccba19)

1.0.2 (2019-11-12)

Bug Fixes

• deps: remove unused yargs dep (#5) (1f87fbb)

1.0.1 (2019-11-11)

Bug Fixes

• license: license to Google (#3) (7f7ff0f)

1.0.0 (2019-11-08)

Features

• flesh out initial plugin (9cbc5e3)