A class for storing information about a reference target.
| NaturalDocs:: | 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. |
| Symbol | Returns the target’s SymbolString. |
| File | Returns the FileName the target is defined in. |
| Type | Returns the target’s TopicType. |
| 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.
| SYMBOL | The target SymbolString. |
| FILE | The FileName the target is defined in. |
| TYPE | The target TopicType. |
| PROTOTYPE | The target’s prototype, or undef if none. |
| SUMMARY | The target’s summary, or undef if none. |
sub New #( symbol, file, type, prototype, summary )
Creates and returns a new object.
| symbol | The target SymbolString. |
| file | The FileName the target is defined in. |
| type | The TopicType of the target symbol. |
| 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 Symbol
Returns the target’s SymbolString.
sub File
Returns the FileName the target is defined in.
sub Type
Returns the target’s TopicType.
Creates and returns a new object.
sub New #( symbol, file, type, prototype, summary )
Returns the target’s SymbolString.
sub Symbol
Returns the FileName the target is defined in.
sub File
Returns the target’s TopicType.
sub Type
Returns the target’s prototype, or undef if not defined or not applicable.
sub Prototype
Returns the target’s summary, or undef if not defined or not applicable.
sub Summary