A jsdoc plugin that allow you documenting complex types and json files
npm install jsdoc3-plugin-propertyofjsdoc3-plugin-memberof
======================
This plugin allows you to split split the documentation of large objects into several documentation blocks.
Lets consider an example:
```js
/**
* The complete Triforce, or one or more components of the Triforce.
* @typedef {Object} Triforce
* @property {boolean} [hasCourage=false] - Indicates whether the Courage component is present.
* @property {boolean} [hasPower=false] - Indicates whether the Power component is present.
* @property {boolean} [hasWisdom=false] - Indicates whether the Wisdom component is present.
*/
``
You can now document it like this:
``js```
/**
* @typedef {Object} Triforce The complete Triforce, or one or more components of the Triforce.
*/
{
/**
* Indicates whether the Courage component is present.
* @type boolean
* @default false
* @propertyof Triforce
*/
hasCourage: false,
/**
* Indicates whether the Power component is present.
* @type boolean
* @default false
* @propertyof Triforce
*/
hasPower: false,
/**
* Indicates whether the Wisdom component is present.
* @type boolean
* @default false
* @propertyof Triforce
*/
hasWisdom: false
}