NaturalDocs::SymbolTable::SymbolDefinition

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

Summary
NaturalDocs::SymbolTable::SymbolDefinitionA class representing a symbol definition.
Implementation
MembersThe class is implemented as a blessed arrayref.
Functions
NewCreates and returns a new object.
TypeReturns the definition’s TopicType.
SetTypeChanges the TopicType.
PrototypeReturns the definition’s prototype, or undef if it doesn’t have one.
SetPrototypeChanges the prototype.
SummaryReturns the definition’s summary, or undef if it doesn’t have one.
SetSummaryChanges the summary.

Implementation

Members

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

TYPEThe symbol TopicType.
PROTOTYPEThe symbol’s prototype, if applicable.  Will be undef otherwise.
SUMMARYThe symbol’s summary, if applicable.  Will be undef otherwise.

Functions

New

sub New #(type,
prototype,
summary)

Creates and returns a new object.

Parameters

typeThe symbol TopicType.
prototypeThe symbol prototype, if applicable.  Undef otherwise.
summaryThe symbol’s summary, if applicable.  Undef otherwise.

Type

sub Type

Returns the definition’s TopicType.

SetType

sub SetType #(type)

Changes the TopicType.

Prototype

sub Prototype

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

SetPrototype

sub SetPrototype #(prototype)

Changes the prototype.

Summary

sub Summary

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

SetSummary

sub SetSummary #(summary)

Changes the summary.

sub New #(type,
prototype,
summary)
Creates and returns a new object.
sub Type
Returns the definition’s TopicType.
A string representing a topic type as defined in Topics.txt.
sub SetType #(type)
Changes the TopicType.
sub Prototype
Returns the definition’s prototype, or undef if it doesn’t have one.
sub SetPrototype #(prototype)
Changes the prototype.
sub Summary
Returns the definition’s summary, or undef if it doesn’t have one.
sub SetSummary #(summary)
Changes the summary.
Close