https://github.com/uppercod/jsdoc
https://github.com/uppercod/jsdoc
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/uppercod/jsdoc
- Owner: UpperCod
- Created: 2021-06-08T22:08:16.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-09T17:44:25.000Z (about 5 years ago)
- Last Synced: 2025-01-24T21:02:21.489Z (over 1 year ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @uppercod/jsdoc
Returns JSDOC type comments in simple block format, for later analysis.
## Install
```
npm install @uppercod/jsdoc
```
## Example
```js
import { parse, parseComment } from "@uppercod/jsdoc";
parseComment(`
description...
@param {number} foo - bla bla...
`);
[
{ children: ["description..."] },
{
tag: "param",
type: "number",
name: "foo",
children: ["bla bla..."],
},
];
```