Provides methods for augmenting the parse results based on their content.
- Source:
Methods
(static) addImplemented(docsnon-null) → {void}
Add and update doclets to reflect implementations of interfaces.
For example, if `InterfaceA` has the instance method `myMethod`, and `ClassA` implements
`InterfaceA`, calling this method does the following:
+ Updates `InterfaceA` to indicate that it is implemented by `ClassA`
+ Updates `InterfaceA#myMethod` to indicate that it is implemented by `ClassA#myMethod`
+ Updates `ClassA#myMethod` to indicate that it implements `InterfaceA#myMethod`
If `ClassA#myMethod` used the `@override` or `@inheritdoc` tag, calling this method would also
generate a new doclet that reflects the interface's documentation for `InterfaceA#myMethod`.
Parameters:
| Name | Type | Description |
|---|---|---|
docs |
Array.<module:jsdoc/doclet.Doclet> | The doclets generated by JSDoc. |
doclets.index |
Object | The doclet index added by module:jsdoc/borrow.indexAll. |
- Source:
Returns:
- Type
- void
(static) addInherited(docletsnon-null) → {void}
Add doclets to reflect class inheritance.
For example, if `ClassA` has the instance method `myMethod`, and `ClassB` inherits from `ClassA`,
calling this method creates a new doclet for `ClassB#myMethod`.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
doclets |
Array.<module:jsdoc/doclet.Doclet> | The doclets generated by JSDoc.
Properties
|
- Source:
Returns:
- Type
- void
(static) addMixedIn(docletsnon-null) → {void}
Add doclets to reflect mixins. When a symbol is mixed into a class, the class' version of the
mixed-in symbol is treated as an instance member.
For example:
+ If `MixinA` has the static method `myMethod`, and `MixinB` mixes `MixinA`, calling this method
creates a new doclet for the static method `MixinB.myMethod`.
+ If `MixinA` has the static method `myMethod`, and `ClassA` mixes `MixinA`, calling this method
creates a new doclet for the instance method `ClassA#myMethod`.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
doclets |
Array.<module:jsdoc/doclet.Doclet> | The doclets generated by JSDoc.
Properties
|
- Source:
Returns:
- Type
- void
(static) augmentAll() → {void}
Add and update doclets to reflect all of the following:
+ Inherited classes
+ Mixins
+ Interface implementations
Calling this method is equivalent to calling all other methods exported by this module.
- Source:
Returns:
- Type
- void