Module: jsdoc/doclet

Classes

Doclet
Doclet
Doclet

Members

Doclet

Source:

_

Source:

code

Source:

docletSrc

Source:

docletSrc

Source:

docletSrc

Source:

docletSrc

Source:

enumerable

Source:

errorMessage

Source:

errorMessage

Source:

filepath

Source:

isClass

Source:

jsdoc

Source:

kind

Source:

kind

Source:

kind

Source:

kind

Source:

kind

Source:

kind

Source:

kind

Source:

kind

Source:

newTags

Source:

node

Source:

parsedTag

Source:

path

Source:

pathname

Source:

Syntax

Source:

tagText

Source:

tagTitle

Source:

target[undefined]

Source:

target[undefined]

Source:

target[undefined]

Source:

target[undefined]

Source:

text

Source:

title

Source:

title

Source:

type

Source:

value

Source:

value

Source:

Methods

_replaceDictionary(dict)

Replace the existing tag dictionary with a new tag dictionary. Used for testing only.
Parameters:
Name Type Description
dict module:jsdoc/tag/dictionary.Dictionary The new tag dictionary.
Source:

combine(primary, secondary) → {module:jsdoc/doclet.Doclet}

Combine two doclets into a new doclet.
Parameters:
Name Type Description
primary module:jsdoc/doclet.Doclet The doclet whose properties will be used.
secondary module:jsdoc/doclet.Doclet The doclet to use as a fallback for properties that the primary doclet does not have.
Source:
Returns:
A new doclet that combines the primary and secondary doclets.
Type
module:jsdoc/doclet.Doclet

applyTag()

Source:

codeToKind()

Source:

copyMostProperties(primary, secondary, target, exclude)

Copy all but a list of excluded properties from one of two doclets onto a target doclet. Prefers the primary doclet over the secondary doclet.
Parameters:
Name Type Description
primary module:jsdoc/doclet.Doclet The primary doclet.
secondary module:jsdoc/doclet.Doclet The secondary doclet.
target module:jsdoc/doclet.Doclet The doclet to which properties will be copied.
exclude Array.<string> The names of properties to exclude from copying.
Source:

copySpecificProperties(primary, secondary, target, include)

Copy specific properties from one of two doclets onto a target doclet, as long as the property has a non-falsy value and a length greater than 0. Prefers the primary doclet over the secondary doclet.
Parameters:
Name Type Description
primary module:jsdoc/doclet.Doclet The primary doclet.
secondary module:jsdoc/doclet.Doclet The secondary doclet.
target module:jsdoc/doclet.Doclet The doclet to which properties will be copied.
include Array.<string> The names of properties to copy.
Source:

dooper()

Source:

expandParamNames()

Source:

fakeMeta()

Source:

fixDescription()

Source:

getFilepath(The) → {string}

Get the full path to the source file that is associated with a doclet.
Parameters:
Name Type Description
The module:jsdoc/doclet.Doclet doclet to check for a filepath.
Source:
Returns:
The path to the doclet's source file, or an empty string if the path is not available.
Type
string

removeGlobal()

Source:

toTags()

Convert the raw source of the doclet comment into an array of pseudo-Tag objects.
Source:

unwrap()

Source: