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

Description (short): Class indices.
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 and iTcl classes.

Superclasses

azIndex
problemIndex

Methods

public: classIndex ()
clear ()
getRef (name)
mref (class name)
oref (class name)
vref (class name)
writeProblemPage ()

Methods

classIndex ()

Constructor, parameterizes the base class.

clear ()

Overrides azIndex:clear, problemIndex:clear
Resets state information

getRef (name)

Overrides azIndex:getRef
Override of baseclass functionality (indexBase:getRef). A class not in the index may have an external dependency defined for it. If that is the case the link associated with that reference is returned. Only if this fails too an error is generated.

Argument: name The name of the class searched by the caller.

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: class The name of the class to look for.

Argument: name The 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: class The name of the class to look for.

Argument: name The 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: class The name of the class to look for.

Argument: name The 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.4 at 09/28/2001, invoked by Andreas Kupries,,,

clear ()
Overrides azIndex:clear, problemIndex:clear Resets state information

getRef (name)
Overrides azIndex:getRef Override of baseclass functionality (indexBase:getRef). A class not in the index may have an external dependency defined for it. If that is the case the link associated with that reference is returned. Only if this fails too an error is generated.
Argument: name	The name of the class searched by the caller.

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: class	The name of the class to look for.
Argument: name	The 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: class	The name of the class to look for.
Argument: name	The 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: class	The name of the class to look for.
Argument: name	The 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.