Class: RootTutorial

jsdoc/tutorial.RootTutorial

Represents the root tutorial.

Constructor

new RootTutorial()

Source:

Extends

Methods

_addTutorial(child)

Add a child tutorial to the root.
Parameters:
Name Type Description
child module:jsdoc/tutorial.Tutorial Child tutorial.
Source:

addChild(child)

Adds new children to current node.
Parameters:
Name Type Description
child Tutorial New child.
Inherited From:
Source:

getByName(name) → {module:jsdoc/tutorial.Tutorial}

Retrieve a tutorial by name.
Parameters:
Name Type Description
name string Tutorial name.
Source:
Returns:
Tutorial instance.
Type
module:jsdoc/tutorial.Tutorial

parse() → {string}

Prepares source.
Inherited From:
Source:
Returns:
HTML source.
Type
string

removeChild(child)

Removes children from current node.
Parameters:
Name Type Description
child Tutorial Old child.
Inherited From:
Source:

setParent(parentnullable)

Moves children from current parent to different one.
Parameters:
Name Type Attributes Description
parent Tutorial <nullable>
New parent. If null, the tutorial has no parent.
Inherited From:
Source: