Home | Packages | Files | Procedures | Classes | Keywords | External packages
DependencyList () | ||
| Internal method, generates a string containing references to the packages required by the file. | ||
| Returns: A string containing a comma separated list of package names, each a hyperlink to a location describing the it. |
PostProcessInformation () | ||
| Called to streamline the extracted embedded documentation. |
WriteClassLinks () | ||
| Generate an itemized list of hyperlinks to the descriptions of all classes contained in this file. Used only if classes are outlined. |
WriteHeading () | ||
| Generates the header part of a file description. |
WriteProcedures () | ||
| Generates the descriptions for all procedures defined in this file. Uses different separator rules dependent on the style of procedure descriptions (table vs. definition list). |
author () | ||
| Returns: The author of the file. |
authorSet (author) | ||
| Called by the containing package to propagate its author information. | ||
| Argument: author | Author of containing package. | |
clear () | ||
| Resets state information. |
completeKwIndex () | ||
| complete indexing of lower levels |
dependencies (internal) | ||
| Determines all dependencies of this file. | ||
| Argument: internal | list of packages distributed here, to be removed from all dependency lists. | |
| Returns: List containing all dependencies of this file. | ||
fileDescription () | ||
| Constructor. Initializes the parser functionality in lib/fileParse.tcl. |
firstLetter () | ||
| Overides base classs functionality (azIndexEntry:firstLetter) to use the first letter of the actual filename as indexing criterium, not the first letter of the path. |
getPage () | ||
| Returns: The url of the page containing the file description. |
keywords () | ||
| Returns: The list of keywords this file is indexed under. |
problem (proc) | ||
| Called by procedures to register them as incompletely documented. This is done, additionally the containing file (this one) is registered as a problem too. | ||
| Argument: proc | Handle of the object registering itself. | |
scan () | ||
| Scans the file for embedded documentation and definitions (procedures, classes). |
write () | ||
| Generates the formatted text describing the file. |
writeProblemPage () | ||
| Writes a page containing the detailed problem description of this file. |
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries