Class: Tutorial

jsdoc/tutorial~Tutorial()

Represents a single JSDoc tutorial.

Constructor

new Tutorial()

Source:

Members

children

Source:

content

Source:

longname

Source:

name

Source:

parent

Source:

parent

Source:

title

Source:

type

Source:

Methods

addChild(child)

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

parse() → {string}

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

removeChild(child)

Removes children from current node.
Parameters:
Name Type Description
child Tutorial Old child.
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.
Source:

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

new Tutorial(name, content, type)

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

Members

children

Source:

content

Source:

longname

Source:

name

Source:

parent

Source:

parent

Source:

title

Source:

type

Source:

Methods

addChild(child)

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

parse() → {string}

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

removeChild(child)

Removes children from current node.
Parameters:
Name Type Description
child Tutorial Old child.
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.
Source:

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:

Members

children

Source:

content

Source:

longname

Source:

name

Source:

parent

Source:

parent

Source:

title

Source:

type

Source:

Methods

addChild(child)

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

parse() → {string}

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

removeChild(child)

Removes children from current node.
Parameters:
Name Type Description
child Tutorial Old child.
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.
Source: