A class used to index items by file.
NaturalDocs:: | A class used to index items by file. |
Variables | |
Members | These constants serve as indexes into the object array. |
Functions | |
New | Returns a new object. |
AddItem | Adds an item to this file. |
HasItem | Returns whether the item exists in this file. |
DeleteItem | Deletes the passed item. |
ListItems | Returns an array of all the item strings defined for a particular extension, or an empty list if none. |
These constants serve as indexes into the object array.
ITEMS | An arrayref where an ExtensionID is the index and the members are existence hashrefs of the item strigs defined in this file. The arrayref will always exist, but the hashrefs may be undef. |
Returns a new object.
sub New
Adds an item to this file.
sub AddItem #( ExtensionID extension, string itemString ) => bool
Returns whether the item exists in this file.
sub HasItem #( ExtensionID extension, string itemString ) => bool
Deletes the passed item.
sub DeleteItem #( ExtensionID extension, string itemString ) => bool
Returns an array of all the item strings defined for a particular extension, or an empty list if none.
sub ListItems #( ExtensionID extension ) => string array