Home | Packages | Files | Procedures | Classes | Keywords | External packages
DependencyList () | ||
Internal method, generates a string containing references to the packages required by the class. | ||
Returns: A string containing a comma separated list of package names, each a hyperlink to a location describing the it. |
GetInheritedEntities () | ||
Used during the writing of the class description to obtain the information about all inherited variables, options and methods. |
GetPartRecord (code name) | ||
Argument: code | Internal type code of the part. These are method, option and variable. | |
Argument: name | The name of the method to search for. | |
Returns: class and method object of the method name, or an empty list. |
OptionDescriptionList () | ||
Internal method, generates a definition list containing the descriptions of all defined options. |
OptionList () | ||
Internal method, generates a string containing references to the option descriptions. | ||
Returns: A string containing a comma separated list of option names, each a hyperlink to the associated description. |
PostProcessInformation () | ||
Called to streamline the extracted embedded documentation. This mainly consists of removing superfluous whitespace. Additionally converts a comma separated list of index phrases into a real tcl list. |
ScanMethods () | ||
Internal method. Called to scan the definitions of all methods of this class. |
SetupAnchors () | ||
Internal method. Initializes the anchor array for all options and variables. |
SuperclassList () | ||
Internal method, generates a string containing references to the superclass descriptions. | ||
Returns: A string containing a comma separated list of superclass names, each a hyperlink to the associated description. |
VarDescriptionList () | ||
Internal method, generates a definition list containing the descriptions of all defined variables. |
VarList () | ||
Internal method, generates a string containing references to the variable descriptions. | ||
Returns: A string containing a comma separated list of variable names, each a hyperlink to the associated description. |
WriteHeading (mlist) | ||
Generates the header part of a class description. | ||
Argument: mlist | The list of method objects. Used to create a comma separated list of method names referencing their descriptions later on the page |
WriteMethods (mList) | ||
Internal method used by the page generator routine (write) to produce the output for all methods. Uses different separator rules dependent on the setting of ptable. | ||
Argument: mList | The list of method objects to call. |
author () | ||
Returns: The author of the class |
authorSet (author) | ||
Called by the containing file to propagate its author information. | ||
Argument: author | Author of containing file. |
classDescription () | ||
Constructor. Initializes the parser functionality in lib/classParse.tcl. |
clear () | ||
Resets state information. |
completeKwIndex (phrases) | ||
Called by the containing file to propagate its indexing information. Completes the indexing of key phrases, propagates class information down to all methods without index phrases, then uses the union of all index phrases for the whole class. | ||
Argument: phrases | List of index phrases used by the containing file. |
dependencies (internal) | ||
Determines all dependencies of this class. | ||
Argument: internal | list of packages distributed here, to be removed from all dependency lists. | |
Returns: List containing all dependencies of this class. |
getMRef (name) | ||
Determines wether name is a method of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
getORef (name) | ||
Determines wether name is an option of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
getOvDescription (which name) | ||
Argument: which | A code indicating the type of name. 'v' for variable, 'o' for option. | |
Argument: name | The name of the option/variable to look up. | |
Returns: The description of the specified option or variable. |
getPage () | ||
Returns: The url of the page containing the class description. |
getVRef (name) | ||
Determines wether name is a member variable of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
keywords () | ||
Returns: The list of kywords the class is indexed under. |
mref (name) | ||
Determines wether name is a method of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
oref (name) | ||
Determines wether name is an option of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
refError (what name) | ||
Argument: what | The type of the referenced entity. | |
Argument: name | The name of the unknown entity. | |
Returns: A string formatted as error for cross references to unknown methods or options. Additionally adds the error to the list of problems associated to the entity containing the bogus cross reference. |
scan () | ||
Scans the specification of the class for embedded documentation and definitions (members, methods and options) |
vref (name) | ||
Determines wether name is a member variable of the class or not. | ||
Argument: name | The name to look for. | |
Returns: A link to the page containing the definition, or the name marked as error. |
write () | ||
Generates the formatted text describing the class. |
writeProblemPage () | ||
Writes a page containing the detailed problem description of this class. |
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries