A plugin for Typedoc
When using ES6 modules in Typedoc, each file gets its own listing in "External Modules", i.e., "Globals". This can be annoying, for projects that utilize one file per class, for instance.
Suppose your source files are organized like this:
thing1/foo.ts
thing1/bar.ts
thing2/baz.ts
thing2/qux.ts
Typedoc will create four "External Modules":
- "thing1/foo"
- "thing1/bar"
- "thing2/baz"
- "thing2/qux"
This plugin allows each file to specify the Typedoc External Module its code should belong to. If multiple files belong to the same module, they are merged.
This allows more control over the modules that Typedoc generates. Instead of the four modules above, we could group them into two:
- thing1
- thing2
Typedoc 0.4 has the ability to discover and load typedoc plugins found in node_modules. Simply install the plugin and run typedoc.
npm install --save typedoc-plugin-external-module-name
typedoc
Add a comment block at the top of the file (ES6 module).
Specify the Typedoc External Module using the @module
annotation.
/**
* @module thing1
*/
// foo stuff
/**
* @module thing1
*/
// bar stuff
/**
* @module thing2
*/
// baz stuff
Multiple files may point to the same ES6 module.
To specify the which file's comment block will be used to document the Typedoc Module page, use @preferred
/**
* @module thing2
* @preferred
*
* This comment will be used to document the "thing2" module.
*/
// qux stuff
The @module
annotation should be in the first comment of the file.
For example, if your source files have license comments, they should be below the comment with @module
.
See this issue for details.