Home | Packages | Files | Procedures | Classes | Keywords | External packages
Anchor () | ||
Returns: The name of the anchor at the start of the procedure description. |
ArgDescription (a) | ||
Internal method used by all procedures generating a formatted procedure description. | ||
Argument: a | The name of the procedure argument to look at. | |
Returns: the description of the given argument or an error text. |
ArgName (a) | ||
Internal method used by all procedures generating a formatted procedure description. | ||
Argument: a | The name of the procedure argument to look at. | |
Returns: the given argument itself, or the argument with its defaultvalue attached to it. |
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. |
ProcDescription () | ||
Returns: a string containing the documentation of this procedure or an error text. |
ReportSpamArguments () | ||
Report all arguments which were documented, but are no arguments of the procedure. |
WriteArgumentsAsList () | ||
Generates a definition list describing the arguments of this procedure. |
WriteArgumentsAsTable () | ||
Generates a table describing the arguments of this procedure. |
WriteAsTable () | ||
Generates the formatted text describing the procedure. This method generates a tabular formatting. |
WriteStandard () | ||
Generates the formatted text describing the procedure. This method generates a definition list. |
addProblem (category errortext url) | ||
Overides the baseclass functionality (problems:addProblem) to allow the procedure to signal itself as problematic to its parent (file or class). | ||
Argument: category | Either crossref or desc. | |
Argument: errortext | A description of the problem. | |
Argument: url | Reference to the place of the problem. |
authorSet (author) | ||
Called by the containing file or class to propagate its author information. | ||
Argument: author | Author of containing file. |
completeKwIndex (phrases) | ||
Called by the containing file (or class) to propagate its indexing information. | ||
Argument: phrases | List of index phrases used by the containing file or class. |
firstLetter () | ||
Overides base classs functionality (azIndexEntry:firstLetter) to use the first letter of the actual procedure as indexing criterium, not the first letter of the namespace path. |
getPage () | ||
Returns: The url of the page containing the procedure description. |
hasArgument (a) | ||
Checks wether the procedure has an argument named a. | ||
Argument: a | The name of the possible argument to this procedure. | |
Returns: A boolean value. True if a is an argument of this procedure, or else False. |
keywords () | ||
Returns: The list of keywords this procedure is indexed under. |
pPage () | ||
Special part of the problem reporting facility. Used by the procedures parent to get a handle on the exact location of the detailed problem description. | ||
Returns: a reference to the exact location of the detailed problem description for this procedure. |
procDescription () | ||
Constructor. Initializes the parser functionality in lib/procParse.tcl. |
scan () | ||
Scans the procedure body for embedded documentation. |
write () | ||
Generates the formatted text describing this procedure. In contrast to files, packages and classes no separate page is written. As this method is called from inside fileDescription:write (or classDescription:write) the description will go into this page. This is reflected by pPage too! | ||
Notes: Dependent on the configuration either WriteStandard or WriteAsTable is called to do the real work. |
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries