esdoc-flow-type-plugin
v1.1.0
Published
A flow type plugin for ESDoc [PoC]
Downloads
1,541
Readme
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 defaulttrue
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