Natural Docs
Version 1.2
Natural Docs
Packages
Objects
Languages
Output Formats
Extensions
Documentation
Indexes
Web Site

NaturalDocs:: Languages:: Advanced:: Scope

A class used to store a scope level.

Summary
NaturalDocs:: Languages:: Advanced:: Scope
A class used to store a scope level.
Implementation
The object is implemented as a blessed arrayref.
Functions
New
Creates and returns a new object.
Symbol
Returns the closing symbol of the scope.
Namespace
Returns the namespace of the scope, or undef if none.
SetNamespace
Sets the namespace of the scope.
Package
Returns the package or class of the scope, or undef if none.
SetPackage
Sets the package or class of the scope.
Protection
Returns the protection of the scope, such as public/private/protected.
SetProtection
Sets the protection of the scope.

Implementation

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

SYMBOLThe closing symbol of the scope.
NAMESPACEThe namespace of the scope, if applicable.
PACKAGEThe package or class of the scope.
PROTECTIONThe protection of the scope, such as public/private/protected.

Functions

New

sub New #(symbol,
namespace,
package,
protection)

Creates and returns a new object.

Parameters

symbolThe closing symbol of the scope.
namespaceThe namespace of the scope, if applicable.
packageThe package or class of the scope.
protectionThe protecetion of the scope, such as public/private/protected.

If either namespace, package, or protection are set to undef, it is assumed that it inherits the value of the previous scope on the stack.

Symbol

sub Symbol

Returns the closing symbol of the scope.

Namespace

sub Namespace

Returns the namespace of the scope, or undef if none.

SetNamespace

sub SetNamespace #(namespace)

Sets the namespace of the scope.

Package

sub Package

Returns the package or class of the scope, or undef if none.

SetPackage

sub SetPackage #(package)

Sets the package or class of the scope.

Protection

sub Protection

Returns the protection of the scope, such as public/private/protected.

SetProtection

sub SetProtection #(protection)

Sets the protection of the scope.
Copyright © 2003-2004 Greg Valure.  Generated by Natural Docs.
sub New #(symbol,
namespace,
package,
protection)
Creates and returns a new object.
sub Symbol
Returns the closing symbol of the scope.
sub Namespace
Returns the namespace of the scope, or undef if none.
sub SetNamespace #(namespace)
Sets the namespace of the scope.
sub Package
Returns the package or class of the scope, or undef if none.
sub SetPackage #(package)
Sets the package or class of the scope.
sub Protection
Returns the protection of the scope, such as public/private/protected.
sub SetProtection #(protection)
Sets the protection of the scope.