Module: jsdoc/tag/dictionary/definitions

Define tags that are known in JSDoc.
Source:

Members

module:jsdoc/tag/dictionary/definitions

Source:

baseTags

Source:

baseTags

Source:

closureTags

Source:

closureTags

Source:

jsdocTags

Source:

mustHaveValue

Source:

_

Source:

baseTags

Source:

baseTags

Source:

canHaveName

Source:

closeIdx

Source:

combined

Source:

combined

Source:

DEFINITIONS

Source:

dictionaries

Source:

dictionaries

Source:

doclet[undefined]

Source:

filepath

Source:

hasOwnProp

Source:

internalTags

Source:

jsdoc

Source:

looksLikeDesc

Source:

MODULE_NAMESPACE

Source:

mustNotHaveDescription

Source:

mustNotHaveValue

Source:

openIdx

Source:

ownerClassName

Source:

ownerClassName

Source:

path

Source:

requiresName

Source:

requiresName

Source:

requiresName

Source:

result

Source:

result

Source:

source

Source:

synonyms

Source:

Syntax

Source:

tagDef

Source:

target

Source:

target

Source:

text

Source:

text

Source:

text

Source:

text

Source:

title

Source:

title

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

value

Source:

Methods

defineTags(dictionary, tagDefinitionsopt)

Populate the given dictionary with the appropriate JSDoc tag definitions. If the `tagDefinitions` parameter is omitted, JSDoc uses its configuration settings to decide which tags to add to the dictionary. If the `tagDefinitions` parameter is included, JSDoc adds only the tag definitions from the `tagDefinitions` object. The configuration settings are ignored.
Parameters:
Name Type Attributes Description
dictionary module:jsdoc/tag/dictionary
tagDefinitions Object <optional>
 A dictionary whose values define the rules for a JSDoc tag.
Source:

onTagged()

Source:

addTagDefinitions()

Source:

applyNamespace()

Source:

cloneTagDef()

Source:

combineTypes()

Source:

filepathMinusPrefix()

Source:

firstWordOf()

Source:

getSourcePaths()

Source:

ignore()

Source:

parseBorrows()

Source:

parseTypeText()

Source:

setDocletDescriptionToValue()

Source:

setDocletKindToTitle()

Source:

setDocletMemberof()

Source:

setDocletNameToFilename()

Source:

setDocletNameToValue()

Source:

setDocletNameToValueName()

Source:

setDocletScopeToTitle()

Source:

setDocletTypeToValueType()

Source:

setNameToFile()

Source:

stripModuleNamespace()

Source: