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

Description (short): File indices.
Written by: Andreas Kupries
Description: Management of file indices.
Keywords: files, file index, indices

Class 'fileIndex'

Description

Manages a single files index. Entries are the tcl files encountered during the scan of the directory hierarchy.

Superclasses

azIndex

Methods

public: clear ()
fileIndex ()
getRef (name)
writeProblemPage ()

Methods

clear ()

Overrides azIndex:clear
Resets state information

fileIndex ()

Constructor, parameterizes the baseclass.

getRef (name)

Overrides azIndex:getRef
Override of baseclass functionality (indexBase:getRef). A file not in the index is searched relative to the basedir of the distribution and not marked as error (if it exists.)

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

writeProblemPage ()

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

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

getRef (name)
Overrides azIndex:getRef Override of baseclass functionality (indexBase:getRef). A file not in the index is searched relative to the basedir of the distribution and not marked as error (if it exists.)
Argument: name	The name of the file searched by the caller.

writeProblemPage ()
Writes a page containing references to the detailed problem descriptions of files having such.