https://github.com/zakkudo/jsdoc-native-plugin
Adds tags to help document native functionality of javscript/html without having to copy-paste text around.
https://github.com/zakkudo/jsdoc-native-plugin
Last synced: 2 months ago
JSON representation
Adds tags to help document native functionality of javscript/html without having to copy-paste text around.
- Host: GitHub
- URL: https://github.com/zakkudo/jsdoc-native-plugin
- Owner: zakkudo
- Created: 2018-08-05T04:55:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-08T04:41:39.000Z (almost 7 years ago)
- Last Synced: 2025-03-08T22:47:31.684Z (3 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jsdoc-native-plugin
Adds tags to help document native functionality of javscript/html without having to copy-paste text around.
Install with:
```sh
yarn add --dev @zakkudo/jsdoc-native-plugin
```
Add to your jsdoc config with:
```js
"plugins": [
"@zakkudo/jsdoc-native-plugin"
],
```
Includes typedefs for
- `Native` namespace
- `Native.DocumentFragment`
- `Native.CustomEvent`
- `Native.Promise`
- ...this will likely grow in the future. Pull requests welcome!