An object that stores information about what hierarchy information is present in a file. It does not store its FileName; it assumes that it will be stored in a hashref where the key is the FileName.
| NaturalDocs:: | An object that stores information about what hierarchy information is present in a file. |
| Implementation | Since there’s only one member in the class, and it’s a hashref, the class is simply the hashref itself blessed as a class. |
| Modification Functions | |
| New | Creates and returns a new class. |
| AddClass | Adds a rew class SymbolString to the file. |
| DeleteClass | Deletes a class SymbolString from the file. |
| AddParentReference | Adds a parent ReferenceString to a class SymbolString. |
| DeleteParentReference | Deletes a parent ReferenceString from a class SymbolString. |
| Information Functions | |
| Classes | Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none. |
| HasClass | Returns whether the file defines the passed class SymbolString. |
| ParentReferencesOf | Returns an array of the parent ReferenceStrings that are defined by the class, or an empty array if none. |
| HasParentReference | Returns whether the file defines the passed class SymbolString and parent ReferenceString. |
Since there’s only one member in the class, and it’s a hashref, the class is simply the hashref itself blessed as a class. The keys are the class SymbolStrings that are defined in the file, and the values are existence hashrefs of each class’ parent ReferenceStrings, or undef if none.
sub AddClass #( class )
Adds a rew class SymbolString to the file.
sub DeleteClass #( class )
Deletes a class SymbolString from the file.
sub AddParentReference #( class, parentReference )
Adds a parent ReferenceString to a class SymbolString.
sub DeleteParentReference #( class, parent )
Deletes a parent ReferenceString from a class SymbolString.
sub Classes
Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none.
sub HasClass #( class )
Returns whether the file defines the passed class SymbolString.
sub ParentReferencesOf #( class )
Returns an array of the parent ReferenceStrings that are defined by the class, or an empty array if none.
sub HasParentReference #( class, parent )
Returns whether the file defines the passed class SymbolString and parent ReferenceString.
Creates and returns a new class.
sub New
Adds a rew class SymbolString to the file.
sub AddClass #( class )
Deletes a class SymbolString from the file.
sub DeleteClass #( class )
Adds a parent ReferenceString to a class SymbolString.
sub AddParentReference #( class, parentReference )
Deletes a parent ReferenceString from a class SymbolString.
sub DeleteParentReference #( class, parent )
Returns an array of the class SymbolStrings that are defined by this file, or an empty array if none.
sub Classes
Returns whether the file defines the passed class SymbolString.
sub HasClass #( class )
Returns an array of the parent ReferenceStrings that are defined by the class, or an empty array if none.
sub ParentReferencesOf #( class )
Returns whether the file defines the passed class SymbolString and parent ReferenceString.
sub HasParentReference #( class, parent )