NaturalDocs::SourceDB::ItemDefinition

A base class for all item definitions for extensions that track more than existence.

Summary
NaturalDocs::SourceDB::ItemDefinitionA base class for all item definitions for extensions that track more than existence.
Functions
CompareReturns whether the definitions are equal.

Functions

Compare

sub Compare #(other)

Returns whether the definitions are equal.  This version returns true by default, you must override it in your subclasses to make the results relevant.  This is important for <NaturalDocs::SourceDB->AnalyzeTrackedFileChanges()>.

This will only be called between objects of the same ExtensionID.  If you use multiple derived classes for the same ExtensionID, you will have to take that into account yourself.

Parameters

otherAnother NaturalDocs::SourceDB::ItemDefinition-derived object to compare this one to.  It will always be from the same ExtensionID.

Returns

Whether they are equal.

sub Compare #(other)
Returns whether the definitions are equal.
A unique identifier for each NaturalDocs::SourceDB extension as given out by RegisterExtension().
A base class for all item definitions for extensions that track more than existence.
Close