Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src Additional Flow type parsing improvements. Dec 16, 2017
test Add tests for enhanced Flow type extraction. Nov 16, 2017
CHANGELOG.md chore(importpath): bump 1.0.2 Apr 29, 2018
LICENSE chore: add license Nov 12, 2017
README.md doc(Flow): example Jun 4, 2017
package.json chore(flow-type): bump 1.0.2 Apr 29, 2018

README.md

ESDoc Flow Type Plugin (PoC)

This plugin is proof of concept.

Install

npm install esdoc-flow-type-plugin

Config

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    {"name": "esdoc-flow-type-plugin", "option": {"enable": true}}
  ]
}
  • enable is default true

Example

export class Foo {
  // without document
  member: number;
  
  // 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