NaturalDocs:: SymbolTable:: ReferenceTarget

A class for storing information about a reference target.

Summary

NaturalDocs:: SymbolTable:: ReferenceTarget	A class for storing information about a reference target.
Implementation
Members	The class is implemented as a blessed arrayref.
Functions
New	Creates and returns a new object.
Class	Returns the target’s class, or undef if it’s global.
Symbol	Returns the target’s symbol.
File	Returns the file the target is defined in.
Type	Returns the target’s type.
Prototype	Returns the target’s prototype, or undef if not defined or not applicable.
Summary	Returns the target’s summary, or undef if not defined or not applicable.

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

CLASS	The target class, or undef if global.
SYMBOL	The target symbol.
FILE	The file the target is defined as.
TYPE	The target type. Will be one of the <Topic Types>.
PROTOTYPE	The target’s prototype, or undef if none.
SUMMARY	The target’s summary, or undef if none.

Creates and returns a new object.

class	The target class, or undef if global.
symbol	The target symbol.
file	The file the target is defined in.
type	The type of the target symbol. Will be one of the <Topic Types>.
prototype	The target’s prototype. Set to undef if not defined or not applicable.
summary	The target’s summary. Set to undef if not defined or not applicable.

sub Prototype

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