NaturalDocs:: Languages:: Advanced:: ScopeChange

A class used to store a scope change.

Summary
A class used to store a scope change.
The object is implemented as a blessed arrayref.
Creates and returns a new object.
Returns what the scope was changed to.
Replaces what the scope was changed to.
Returns the line number of the change.

Implementation

The object is implemented as a blessed arrayref.  The constants below are used as indexes.

SCOPEThe new scope.
LINE_NUMBERThe line number of the change.

Functions

New

sub New #(scope,
lineNumber)

Creates and returns a new object.

Parameters

scopeWhat the scope was changed to.
lineNumberWhat line it occurred on.

Scope

sub Scope

Returns what the scope was changed to.

SetScope

sub SetScope #(scope)

Replaces what the scope was changed to.

LineNumber

sub LineNumber

Returns the line number of the change.

sub New #(scope,
lineNumber)
Creates and returns a new object.
sub Scope
Returns what the scope was changed to.
sub SetScope #(scope)
Replaces what the scope was changed to.
sub LineNumber
Returns the line number of the change.