typedoc-plugin-external-module-name

class ExternalModuleNamePlugin

@Component({ name: 'external-module-name' })
export class ExternalModuleNamePlugin extends ConverterComponent {}

• This plugin allows an ES6 module to specify its TypeDoc name. It also allows multiple ES6 modules to be merged together into a single TypeDoc module.

  At the top of an ES6 module, add a "dynamic module comment". Insert "@module typedocModuleName" to specify that this ES6 module should be merged with module: "typedocModuleName".

  Similar to the [[DynamicModulePlugin]], ensure that there is a comment tag (even blank) for the first symbol in the file.

  Example 1

  /**
   * @module newModuleName
   */
  /** for typedoc /
  import {foo} from "../foo";
  export let bar = "bar";

  Also similar to [[DynamicModulePlugin]], if is found in a dynamic module comment, the comment will be used as the module comment, and documentation will be generated from it (note: this plugin does not attempt to count lengths of merged module comments in order to guess the best one)