Package Exports
- @sebastianwessel/esdoc-typescript-plugin
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sebastianwessel/esdoc-typescript-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ESDoc TypeScript Plugin (PoC)
This plugin is proof of concept
Install
npm install esdoc-typescript-pluginConfig
{
"source": "./src",
"destination": "./doc",
"plugins": [
{"name": "esdoc-typescript-plugin", "option": {"enable": true}}
]
}enableis 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