1.0.1 • Published 2 years ago

typedoc-plugin-file-tags v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

typedoc-plugin-file-tags

A plugin for Typedoc to allow setting category tags at the file level.

npm

Installation

npm install typedoc-plugin-file-tags --save-dev

Usage

Include @category tags at the file level.

/**
 * These tags will be applied to all the exports of this file.
 * @module
 * @category Math
 */

export function add(a, b) {
  return a + b;
}

/** Subtracts `b` from `a` */
export function subtract(a, b) {
  return a - b;
}