Class: Tutorial | DOCOLATTE

jsdoc/tutorial~Tutorial(name, content, type)

Represents a single JSDoc tutorial.

Constructor

new Tutorial(name, content, type)

Parameters:

Name	Type	Description
`name`	string	Tutorial name.
`content`	string	Text content.
`type`	number	Source formating.

Source:: node_modules/jsdoc/lib/jsdoc/tutorial.js, line 37

Methods

addChild(child)

Adds new children to current node.

Parameters:

Name	Type	Description
`child`	Tutorial	New child.

Source:: node_modules/jsdoc/lib/jsdoc/tutorial.js, line 87

parse() → string

Prepares source.

Source:: node_modules/jsdoc/lib/jsdoc/tutorial.js, line 96

Returns:

HTML source.

Type:: string

removeChild(child)

Removes children from current node.

Parameters:

Name	Type	Description
`child`	Tutorial	Old child.

Source:: node_modules/jsdoc/lib/jsdoc/tutorial.js, line 77

setParent(parentnull)

Moves children from current parent to different one.

Parameters:

Name	Type	Description
`parent`null	Tutorial	New parent. If null, the tutorial has no parent.

Source:: node_modules/jsdoc/lib/jsdoc/tutorial.js, line 59