esdoc2-typescript-plugin
v2.0.0
Published
A TypeScript plugin for esdoc2 [PoC]
Downloads
7
Maintainers
Readme
esdoc2 TypeScript Plugin (PoC)
This plugin is proof of concept
Install
npm install esdoc2-typescript-plugin
Config
{
"source": "./src",
"destination": "./doc",
"plugins": [
{"name": "esdoc2-typescript-plugin", "option": {"enable": true}}
]
}
enable
is defaulttrue
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