NaturalDocs::Languages::Advanced::ScopeChange

A class used to store a scope change.

Summary
NaturalDocs::Languages::Advanced::ScopeChangeA class used to store a scope change.
Constants
ImplementationThe object is implemented as a blessed arrayref.
Functions
NewCreates and returns a new object.
ScopeReturns the SymbolString the scope was changed to.
SetScopeReplaces the SymbolString the scope was changed to.
LineNumberReturns the line number of the change.

Constants

Implementation

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

SCOPEThe new scope SymbolString.
LINE_NUMBERThe line number of the change.

Functions

New

sub New #(scope,
lineNumber)

Creates and returns a new object.

Parameters

scopeThe SymbolString the scope was changed to.
lineNumberWhat line it occurred on.

Scope

sub Scope

Returns the SymbolString the scope was changed to.

SetScope

sub SetScope #(scope)

Replaces the SymbolString 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 the SymbolString the scope was changed to.
A scalar which encodes a normalized array of identifier strings representing a full or partially-resolved symbol.
sub SetScope #(scope)
Replaces the SymbolString the scope was changed to.
sub LineNumber
Returns the line number of the change.
Close