File 'lib/depIndex.cls' (part of 'AutoDOC')

Description (short): Dependency indices.
Written by: Andreas Kupries
Description: Management of dependency indices.
Keywords: dependencies, dependency index, indices

Class 'depIndex'

Description

Management of a dependency index. Entries are external packages used by the documented code. The associated descriptions refer to the entities requiring the different packages.

Superclasses

indexBase

Methods

public: addItem (pkg object)
clear ()
depIndex ()
writeIndexBody ()

Membervariables

public: pkgUsers

Methods

addItem (pkg object)

Overrides indexBase:addItem
Adds the external package pkg to the index. The additionally specified object depends on this package.

Argument: pkg Thee name of the package added to the index.

Argument: object The handle of the object which is dependent on the package.

clear ()

Overrides indexBase:clear
Resets state information.

depIndex ()

Constructor, parameterizes the base class

writeIndexBody ()

Overrides indexBase:writeIndexBody
Overrides base class definition (indexBase:writeIndexBody) to deal with our special index information. Generates the required formatting for this index.

Membervariables

pkgUsers: The index maintained by this class. Most member variables of the baseclass are of no relevance here. Maps from package names to the objects requiring them.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

addItem (pkg object)
Overrides indexBase:addItem Adds the external package pkg to the index. The additionally specified object depends on this package.
Argument: pkg	Thee name of the package added to the index.
Argument: object	The handle of the object which is dependent on the package.

writeIndexBody ()
Overrides indexBase:writeIndexBody Overrides base class definition (indexBase:writeIndexBody) to deal with our special index information. Generates the required formatting for this index.