https://github.com/zakkudo/jsdoc-polymer-plugin
A port of polymer 3 tags for jsdoc
https://github.com/zakkudo/jsdoc-polymer-plugin
Last synced: 2 months ago
JSON representation
A port of polymer 3 tags for jsdoc
- Host: GitHub
- URL: https://github.com/zakkudo/jsdoc-polymer-plugin
- Owner: zakkudo
- Created: 2018-08-02T14:54:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-05T04:59:47.000Z (almost 7 years ago)
- Last Synced: 2025-03-08T13:19:40.301Z (3 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jsdoc-polymer-plugin
Adds tags to help document polymer functionality without having to copy-paste text around and allowing disallowing undefined tags. Most of these match up to the official polymer documention tags, but ported for jsdoc.
Install with:
```sh
yarn add --dev @zakkudo/jsdoc-polymer-plugin
```
Add to your jsdoc config with:
```js
"plugins": [
"@zakkudo/jsdoc-polymer-plugin"
],
```
Document your mixins like this this way:
```js
/**
* Add Application action creators to a polymer class. It also connects the
* component to the Redux store as well as manage any passed saga scripts.
* @module Application/ActionsMixin
* @polymer
* @mixinFunction
* @appliesMixin SagaMixin
* @param {Polymer.PolymerElement} Parent - The class to mix into
* @param {Function} saga - The saga to start with connection of the element to the DOM.
* It will be stopped when disconnected.
* @return {Polymer.PolymerElement} The wrapped class
*/
export default (Parent, {actions, saga, store}) => {
```
Document your components like this
```js
/**
* A toggle button which customizable label
* @module lib/components/Toggle
* @customElement
* @polymer
*
*/
```
Added tags include
- `@polymer`
- `@appliesMixin`
- `@customElement`
- `@mixinClass`
- `@mixinFunction`
- `@polymerBehavior`
Includes typedefs for
- `Polymer` namespace
- `Polymer.PolymerElement` typedef to describe a polymer class