@sebastianwessel/esdoc-typescript-plugin

ESDoc TypeScript Plugin (PoC)

This plugin is proof of concept

Install

npm install esdoc-typescript-plugin

Config

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {"name": "esdoc-typescript-plugin", "option": {"enable": true}}
  ]
}

• enable is default true

Example

export class Foo {
  // without document, with initializer
  member: number = 10;
  
  // without document
  method1(n: number): string {
  }
  
  // without @param and @return
  /**
   * this is method2.
   */
  method2(n: number): string {
  }
  
  // without type in @param and @return
  /**
   * this is method3.
   * @param n - this is param desc.
   * @return this is return desc. 
   */
  method3(n: number): string {
  }
}

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru