SCDocNode: table of contents
Filter:
Classes | HelpSystem

SCDocNode : Object

An SCDoc parsed document node
Source: SCDoc.sc

Description

This class is used internally by SCDoc to represent a node in the parsed document tree returned by the parser. It has an id symbol, optional text and optional children.

Class Methods

SCDocNode.new(maxSize: 0)

From superclass: Object

Create a new node

Inherited class methods

Instance Methods

.id

.id = value

The node ID. A Symbol

.text

.text = value

Text associated with this node. A String or nil.

.children

.children = value

Children of this node. A Array or nil.

.merge(root2)

Merge another document node tree with this one. Used by document additions (*.ext.schelp)

Arguments:

root2

Another SCDocNode instance.

.findChild(id)

Find the first child of this node with specified id.

Arguments:

id

A Symbol

Inherited instance methods