A class representing a file, keeping track of what symbols and references are defined in it.
NaturalDocs:: | A class representing a file, keeping track of what symbols and references are defined in it. |
Implementation | |
Members | The class is implemented as a blessed arrayref. |
Modification Functions | |
New | Creates and returns a new object. |
AddSymbol | Adds a SymbolString definition. |
DeleteSymbol | Removes a SymbolString definition. |
AddReference | Adds a reference definition. |
DeleteReference | Removes a reference definition. |
Information Functions | |
HasAnything | Returns whether the file has any symbol or reference definitions at all. |
Symbols | Returns an array of all the SymbolStrings defined in this file. |
References | Returns an array of all the ReferenceStrings defined in this file. |
DefinesSymbol | Returns whether the file defines the passed SymbolString or not. |
DefinesReference | Returns whether the file defines the passed ReferenceString or not. |
The class is implemented as a blessed arrayref. The following constants are its members.
SYMBOLS | An existence hashref of the SymbolStrings it defines. |
REFERENCES | An existence hashref of the ReferenceStrings in the file. |
sub DeleteSymbol #( symbol )
Removes a SymbolString definition.
symbol | The SymbolString to delete. |
sub AddReference #( referenceString )
Adds a reference definition.
referenceString | The ReferenceString being added. |
sub DeleteReference #( referenceString )
Removes a reference definition.
referenceString | The ReferenceString to delete. |
sub Symbols
Returns an array of all the SymbolStrings defined in this file. If none, returns an empty array.
sub References
Returns an array of all the ReferenceStrings defined in this file. If none, returns an empty array.
sub DefinesSymbol #( symbol )
Returns whether the file defines the passed SymbolString or not.
sub DefinesReference #( referenceString )
Returns whether the file defines the passed ReferenceString or not.
Creates and returns a new object.
sub New
Adds a SymbolString definition.
sub AddSymbol #( symbol )
Removes a SymbolString definition.
sub DeleteSymbol #( symbol )
Adds a reference definition.
sub AddReference #( referenceString )
Removes a reference definition.
sub DeleteReference #( referenceString )
Returns whether the file has any symbol or reference definitions at all.
sub HasAnything
Returns an array of all the SymbolStrings defined in this file.
sub Symbols
Returns an array of all the ReferenceStrings defined in this file.
sub References
Returns whether the file defines the passed SymbolString or not.
sub DefinesSymbol #( symbol )
Returns whether the file defines the passed ReferenceString or not.
sub DefinesReference #( referenceString )