Module: jsdoc/augment

Provides methods for augmenting the parse results based on their content.
Source:

Classes

Sorter
Sorter

Members

additionIndexes

Source:

additionIndexes

Source:

additionIndexes

Source:

additions[undefined]

Source:

childDoclet

Source:

childDoclet

Source:

childDoclet

Source:

childDoclet

Source:

childLongname

Source:

childLongname

Source:

doc

Source:

doc

Source:

doclet

Source:

doclet

Source:

doclet

Source:

doclets

Source:

doclets

Source:

doclets[undefined][undefined]

Source:

documented

Source:

documented

Source:

documented

Source:

documented[undefined]

Source:

doop

Source:

hasOwnProp

Source:

idx

Source:

implDoclets

Source:

implDoclets

Source:

implementationDoclet

Source:

implementations

Source:

implExists

Source:

index

Source:

index

Source:

indexes[undefined]

Source:

inherits

Source:

interfaceDoclets

Source:

jsdoc

Source:

kind

Source:

len

Source:

longname

Source:

member

Source:

memberof

Source:

memberof

Source:

memberof

Source:

memberof[undefined]

Source:

mixedDoclet

Source:

mixedDoclets

Source:

mixedName

Source:

mixes

Source:

mixinDoclets

Source:

name

Source:

names

Source:

parentDoclet

Source:

parentDoclet

Source:

parentMembers

Source:

parents

Source:

parts

Source:

Methods

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.
Source:
Returns:
Type
void

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
Name Type Description
index Object The doclet index.
Source:
Returns:
Type
void

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
Name Type Description
index Object The doclet index.
Source:
Returns:
Type
void

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

addDocletProperty()

Source:

augment()

Source:

changeMemberof()

Source:

explicitlyInherits()

Source:

getDocumentedLongname()

Source:

getImplementedAdditions()

Source:

getInheritedAdditions()

Source:

getMembers()

Source:

getMixedInAdditions()

Source:

mapDependencies()

Source:

parentIsClass()

Source:

reparentDoclet()

Source:

sort()

Source:

staticToInstance()

Source:

updateAddedDoclets(doclet, additions, indexes) → {void}

Update the list of doclets to be added to another symbol. We add only one doclet per longname. For example: If `ClassA` inherits from two classes that both use the same method name, `ClassA` gets docs for one method rather than two. Also, the last symbol wins for any given longname. For example: If you write `@extends Class1
Parameters:
Name Type Description
doclet module:jsdoc/doclet.Doclet The doclet to be added.
additions Array.<module:jsdoc/doclet.Doclet> An array of doclets that will be added to another symbol.
indexes Object.<string, number> A dictionary of indexes into the `additions` array. Each key is a longname, and each value is the index of the longname's doclet.
Source:
Returns:
Type
void

updateDocumentedDoclets(doclet, documented) → {void}

Update the index of doclets whose `undocumented` property is not `true`.
Parameters:
Name Type Description
doclet module:jsdoc/doclet.Doclet The doclet to be added to the index.
documented Object.<string, Array.<module:jsdoc/doclet.Doclet>> The index of doclets whose `undocumented` property is not `true`.
Source:
Returns:
Type
void

updateImplements()

Source:

updateMemberofDoclets(doclet, memberof) → {void}

Update the index of doclets with a `memberof` value.
Parameters:
Name Type Description
doclet module:jsdoc/doclet.Doclet The doclet to be added to the index.
memberof Object.<string, Array.<module:jsdoc/doclet.Doclet>> The index of doclets with a `memberof` value.
Source:
Returns:
Type
void

updateMixes()

Source: