https://github.com/develar/ts2jsdoc
Generate JSDoc from Typescript
https://github.com/develar/ts2jsdoc
jsdoc typescript
Last synced: about 1 year ago
JSON representation
Generate JSDoc from Typescript
- Host: GitHub
- URL: https://github.com/develar/ts2jsdoc
- Owner: develar
- Created: 2017-03-08T06:20:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-28T21:27:20.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T08:02:39.536Z (about 2 years ago)
- Topics: jsdoc, typescript
- Language: TypeScript
- Homepage:
- Size: 163 KB
- Stars: 61
- Watchers: 3
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Installation
This module requires Node.js 4.0 or higher to run.
```sh
npm install ts-jsdoc --save-dev
```
## Generate JSDoc from TypeScript
In the `tsconfig.js` set `jsdoc` to path to output directory.
```
"jsdoc": "jsdoc/out"
```
Or to options object:
```json
{
"out": "our dir",
"access": "set to public if you want to skip protected members"
}
```
Execute: `ts2jsdoc path-to-dir-with-tsconfig`