Module: jsdoc/src/handlers

Classes

CurrentModule
CurrentModule

Members

basename

Source:

src/handlers.js, line 269

currentModule

Source:

src/handlers.js, line 16

doclet

Source:

src/handlers.js, line 80

doclet

Source:

src/handlers.js, line 49

doclet

Source:

src/handlers.js, line 43

e

Source:

src/handlers.js, line 156

escape

Source:

src/handlers.js, line 4

flatComment

Source:

src/handlers.js, line 46

jsdoc

Source:

src/handlers.js, line 5

longname

Source:

src/handlers.js, line 28

memberof

Source:

src/handlers.js, line 230

memberof

Source:

src/handlers.js, line 216

memberof

Source:

src/handlers.js, line 221

memberof

Source:

src/handlers.js, line 270

memberof

Source:

src/handlers.js, line 258

memberof

Source:

src/handlers.js, line 207

memberofInfo

Source:

src/handlers.js, line 268

memberofInfo

Source:

src/handlers.js, line 257

memberofName

Source:

src/handlers.js, line 169

memberofName

Source:

src/handlers.js, line 173

moduleOriginalName

Source:

src/handlers.js, line 251

msg

Source:

src/handlers.js, line 47

nameAndPunc

Source:

src/handlers.js, line 194

newDoclet

Source:

src/handlers.js, line 340

parentDoclet

Source:

src/handlers.js, line 104

resolveTargetRegExp

Source:

src/handlers.js, line 253

SCOPE_NAMES

Source:

src/handlers.js, line 17

SCOPE_PUNC

Source:

src/handlers.js, line 18

scopePunc

Source:

src/handlers.js, line 222

scopePunc

Source:

src/handlers.js, line 231

scopePunc

Source:

src/handlers.js, line 225

scopePunc

Source:

src/handlers.js, line 208

scopePunc

Source:

src/handlers.js, line 259

skipMemberof

Source:

src/handlers.js, line 114

Syntax

Source:

src/handlers.js, line 19

trailingPunc

Source:

src/handlers.js, line 191

unresolved

Source:

src/handlers.js, line 254

Methods

attachTo(parser)

Attach these event handlers to a particular instance of a parser.

Parameters:

Name	Type	Description
`parser`

Source:

src/handlers.js, line 331

addDoclet()

Source:

src/handlers.js, line 151

addSymbolMemberof()

Source:

src/handlers.js, line 235

createDoclet()

Source:

src/handlers.js, line 37

createSymbolDoclet()

Create a doclet for a `symbolFound` event. The doclet represents an actual symbol that is defined in the code. Here's why this function is useful. A JSDoc comment can define a symbol name by including: + A `@name` tag + Another tag that accepts a name, such as `@function` When the JSDoc comment defines a symbol name, we treat it as a "virtual comment" for a symbol that isn't actually present in the code. And if a virtual comment is attached to a symbol, it's possible that the comment and symbol have nothing to do with one another. To handle this case, this function checks the new doclet to see if we've already added a name property by parsing the JSDoc comment. If so, this method creates a replacement doclet that ignores the attached JSDoc comment and only looks at the code.

Source:

src/handlers.js, line 74

filterByLongname()

Source:

src/handlers.js, line 28

findSymbolMemberof()

Source:

src/handlers.js, line 183

newSymbolDoclet()

Source:

src/handlers.js, line 287

processAlias()

Source:

src/handlers.js, line 165

setCurrentModule()

Source:

src/handlers.js, line 86

setDefaultScope()

Source:

src/handlers.js, line 144

setModuleScopeMemberOf()

Source:

src/handlers.js, line 92