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


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


Written by
Andreas Kupries
Description
Management of class indices.
Keywords
classes, class index, indices

Class 'classIndex'

Description
Manages a single class index. Entries are the classes encountered during the scan of the directory hierarchy. The system recognizes only classes written by using the OO kernel in the Pool_Base package.
Superclasses
azIndex, problemIndex
Methods
classIndex, clear, mref, oref, vref, writeProblemPage

classIndex ()

Constructor, parameterizes the base class.

clear ()

Resets state information

mref (class name)

Determines wether name is a method of class or not and returns the appropriately formatted text (a hyperlink, or the name marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. Errors are added to the list of problems associated to the entity containing the cross reference.
Argument: classThe name of the class to look for.
Argument: nameThe name of the method to look for.
Returns: Formatted text for a hyperlink to the definition of name or the name marked as error.

oref (class name)

Determines wether name is an option of class or not and returns the appropriately formatted text (a hyperlink, or the name marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. Errors are added to the list of problems associated to the entity containing the cross reference.
Argument: classThe name of the class to look for.
Argument: nameThe name of the option to look for.
Returns: Formatted text for a hyperlink to the definition of name or the name marked as error.

vref (class name)

Determines wether name is a member variable of class or not and returns the appropriately formatted text (a hyperlink, or the name marked as error). Indirectly used by distribution:crResolve to resolve embedded crossreferences. Errors are added to the list of problems associated to the entity containing the cross reference.
Argument: classThe name of the class to look for.
Argument: nameThe name of the member variable to look for.
Returns: Formatted text for a hyperlink to the definition of name or the name marked as error.

writeProblemPage ()

Writes a page containing references to the detailed problem descriptions of classes having such.


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