Class: RootTutorial

jsdoc/tutorial~RootTutorial()

Represents the root tutorial.

Constructor

new RootTutorial()

Source:

Extends

Members

_tutorials

Source:

_tutorials[undefined]

Source:

Methods

_addTutorial(child)

Add a child tutorial to the root.
Parameters:
Name Type Description
child module:jsdoc/tutorial.Tutorial Child tutorial.
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

jsdoc/tutorial~RootTutorial()

Represents the root tutorial.

Constructor

new RootTutorial()

Source:

Extends

Members

_tutorials

Source:

_tutorials[undefined]

Source:

Methods

_addTutorial(child)

Add a child tutorial to the root.
Parameters:
Name Type Description
child module:jsdoc/tutorial.Tutorial Child tutorial.
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

jsdoc/tutorial~RootTutorial()

new RootTutorial()

Source:

Members

_tutorials

Source:

_tutorials[undefined]

Source:

Methods

_addTutorial(child)

Add a child tutorial to the root.
Parameters:
Name Type Description
child module:jsdoc/tutorial.Tutorial Child tutorial.
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