A class representing a symbol definition. This does not store the definition symbol, class, or file.
| NaturalDocs:: | A class representing a symbol definition. |
| Implementation | |
| Members | The class is implemented as a blessed arrayref. |
| Functions | |
| New | Creates and returns a new object. |
| Type | Returns the definition’s TopicType. |
| SetType | Changes the TopicType. |
| Prototype | Returns the definition’s prototype, or undef if it doesn’t have one. |
| SetPrototype | Changes the prototype. |
| Summary | Returns the definition’s summary, or undef if it doesn’t have one. |
| SetSummary | Changes the summary. |
The class is implemented as a blessed arrayref. The following constants are its members.
| TYPE | The symbol TopicType. |
| PROTOTYPE | The symbol’s prototype, if applicable. Will be undef otherwise. |
| SUMMARY | The symbol’s summary, if applicable. Will be undef otherwise. |
sub New #( type, prototype, summary )
Creates and returns a new object.
| type | The symbol TopicType. |
| prototype | The symbol prototype, if applicable. Undef otherwise. |
| summary | The symbol’s summary, if applicable. Undef otherwise. |
sub Type
Returns the definition’s TopicType.
sub SetType #( type )
Changes the TopicType.
Creates and returns a new object.
sub New #( type, prototype, summary )
Returns the definition’s TopicType.
sub Type
Changes the TopicType.
sub SetType #( type )
Returns the definition’s prototype, or undef if it doesn’t have one.
sub Prototype
Changes the prototype.
sub SetPrototype #( prototype )
Returns the definition’s summary, or undef if it doesn’t have one.
sub Summary
Changes the summary.
sub SetSummary #( summary )