NaturalDocs:: SymbolTable:: SymbolDefinition

A class representing a symbol definition.  This does not store the definition symbol, class, or file. 

Summary
A class representing a symbol definition.
The class is implemented as a blessed arrayref.
Creates and returns a new object.
Changes the type.
Changes the prototype.
Returns the definition’s type.
Returns the definition’s prototype, or undef if it doesn’t have one.

Implementation

Members

The class is implemented as a blessed arrayref.  The following constants are its members. 

TYPEThe symbol type.  Will be one of the Topic Types
PROTOTYPEThe symbol’s prototype, if applicable.  Will be undef otherwise. 

Modification Functions

New

sub New #(type, prototype)

Creates and returns a new object. 

Parameters

typeThe symbol type.  Should be one of the Topic Types
prototypeThe symbol prototype, if applicable.  Undef otherwise. 

SetType

sub SetType #(type)

Changes the type. 

SetPrototype

sub SetPrototype #(prototype)

Changes the prototype. 

Information Functions

Type

sub Type

Returns the definition’s type.  Will be one of the Topic Types

Prototype

sub Prototype

Returns the definition’s prototype, or undef if it doesn’t have one.