NaturalDocs::SymbolTable::ReferenceTarget

A class for storing information about a reference target.

Summary
NaturalDocs::SymbolTable::ReferenceTargetA class for storing information about a reference target.
Implementation
MembersThe class is implemented as a blessed arrayref.
Functions
NewCreates and returns a new object.
SymbolReturns the target’s SymbolString.
FileReturns the FileName the target is defined in.
TypeReturns the target’s TopicType.
PrototypeReturns the target’s prototype, or undef if not defined or not applicable.
SummaryReturns the target’s summary, or undef if not defined or not applicable.

Implementation

Members

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

SYMBOLThe target SymbolString.
FILEThe FileName the target is defined in.
TYPEThe target TopicType.
PROTOTYPEThe target’s prototype, or undef if none.
SUMMARYThe target’s summary, or undef if none.

Functions

New

sub New #(symbol,
file,
type,
prototype,
summary)

Creates and returns a new object.

Parameters

symbolThe target SymbolString.
fileThe FileName the target is defined in.
typeThe TopicType of the target symbol.
prototypeThe target’s prototype.  Set to undef if not defined or not applicable.
summaryThe target’s summary.  Set to undef if not defined or not applicable.

Symbol

sub Symbol

Returns the target’s SymbolString.

File

sub File

Returns the FileName the target is defined in.

Type

sub Type

Returns the target’s TopicType.

Prototype

sub Prototype

Returns the target’s prototype, or undef if not defined or not applicable.

Summary

sub Summary

Returns the target’s summary, or undef if not defined or not applicable.

sub New #(symbol,
file,
type,
prototype,
summary)
Creates and returns a new object.
sub Symbol
Returns the target’s SymbolString.
A scalar which encodes a normalized array of identifier strings representing a full or partially-resolved symbol.
sub File
Returns the FileName the target is defined in.
A string representing the absolute, platform-dependent path to a file.
sub Type
Returns the target’s TopicType.
A string representing a topic type as defined in Topics.txt.
sub Prototype
Returns the target’s prototype, or undef if not defined or not applicable.
sub Summary
Returns the target’s summary, or undef if not defined or not applicable.
Close