Skip to content

Commit

Permalink
Added blank lines between typedef properties.
Browse files Browse the repository at this point in the history
  • Loading branch information
ma2ciek committed Feb 14, 2019
1 parent b8908e4 commit 521b96d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions packages/jsdoc-plugins/lib/doclet.jsdoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,58 @@
* @typedef {Object} Doclet
*
* @property {String} longname Long name of the doclet (including the `module:` part).
*
* @property {String} name Short name of the doclet (e.g. the name of the method).
*
* @property {String} memberof Where the doclet belongs to (parent of the symbol).
*
* @property {'class'|'interface'|'mixin'|'function'|'typedef'|'event'|'member'|'constant'|'module'} kind The kind of the doclet's symbol.
*
* @property {Boolean} [ignore] `true` for internal doclets which should not be published
*
* @property {Boolean} [undocumented] `true` when a doclet's symbol does not have API docs written above the declaration.
*
* @property {String} [inheritdoc] Specifies whether the `@inheritdoc` tag is present. Warning: When the `@inheritdoc` tag is
* present without no additional docs, then this property becomes an empty string!
*
* @property {Boolean} [overrides]
*
* @property {Array.<Property>} [properties] Typedef properties.
*
* @property {Boolean} [inherited] `true` for a property / method which is inherited from the parent class.
*
* @property {String} [inherits] The longname of the parent class / interface method.
*
* @property {String} [comment] Raw API comment.
*
* @property {String} [description] API Comment wrapped in HTML tags.
*
* @property {Array.<Object>} [params] Event and function params.
*
* @property {'instance'|'inner'|'static'} [scope]
*
* @property {Array.<String>} [fires] An array of events that a method or a property can fire.
*
* @property {Object} meta Doclet's metadata - filename, line number, etc.
*
* @property {Array.<String>} [augments] An array of classes that the doclet's symbol extends.
* Applies for `@class`, `@mixin`, `@interface`.
*
* @property {Array.<String>} [mixes] An array of mixins that the doclet's symbol mixes.
* Applies for `@class` and `@mixin`.
*
* @property {Array.<String>} [implements] An array of interfaces that the doclet's symbol implements.
* Applies for `@class` and `@mixin`.
*
* @property {Array.<String>} [augmentsNested] [A custom property used by the relation fixer] -
* an array of all classes in the inheritance chain augmenting the current doclet's symbol.
*
* @property {Array.<String>} [mixesNested] [A custom property used by the relation fixer] -
* an array of all mixins in the inheritance chain augmenting the current doclet's symbol.
*
* @property {Array.<String>} [implementsNested] [A custom property used by the relation fixer] -
* an array of all interfaces in the inheritance chain, which the current doclet's symbol implements.
*
* @property {Array.<String>} [descendants] [A custom property used by the relation fixer] -
* an array of doclets which inherits / implements / mixes the doclet's symbol.
*/
Expand All @@ -46,7 +69,10 @@
* @typedef {Object} Property
*
* @property {String } name
*
* @property {Object} type
*
* @property {String} description
*
* @property {Boolean} [inherited] [A custom property used by the relation fixer]
*/

0 comments on commit 521b96d

Please sign in to comment.