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


Home | Packages | Files | Procedures | Classes | Keywords | External packages


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
Membervariables
pkgUsers
Methods
addItem, clear, depIndex, writeIndexBody

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.

addItem (pkg object)

Adds the external package pkg to the index. The additionally specified object depends on this package.
Argument: pkgThee name of the package added to the index.
Argument: objectThe handle of the object which is dependent on the package.

clear ()

Resets state information.

depIndex ()

Constructor, parameterizes the base class

writeIndexBody ()

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


Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries