Class: RootTutorial | DOCOLATTE

jsdoc/tutorial~RootTutorial()

Represents the root tutorial.

Constructor

new RootTutorial()

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

Extends

module:jsdoc/tutorial.Tutorial

Methods

_addTutorial(child)

Add a child tutorial to the root.

Parameters:

Name	Type	Description
`child`	module:jsdoc/tutorial.Tutorial	Child tutorial.

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

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

Retrieve a tutorial by name.

Parameters:

Name	Type	Description
`name`	string	Tutorial name.

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

Returns:

Tutorial instance.

Type:: module:jsdoc/tutorial.Tutorial