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


Home | Packages | Files | Procedures | Classes | Keywords | External packages


Written by
Andreas Kupries
Description
Management of procedures and class methods.
Keywords
procedure, method

Class 'procDescription'

Superclasses
azIndexEntry, problems
Options
args, body, parent, table
Membervariables
anchor, argDef, arglist, authorAddress, authorName, comment, danger, keywords, note, result
Methods
Anchor, ArgDescription, ArgName, PostProcessInformation, ProcDescription, ReportSpamArguments, WriteArgumentsAsList, WriteArgumentsAsTable, WriteAsTable, WriteStandard, addProblem, authorSet, completeKwIndex, firstLetter, getPage, hasArgument, keywords, pPage, procDescription, scan, write

-args
List containing the names of all procedure arguments.
-body
Script containing the body of the procedure definition.
-parent
Handle of object containing the procedure. Can be a file or class (fileDescription, classDescription).
-table
Boolean flag. If set procedure documentation is written as table.

anchor
Name of the anchor associated to the procedure.
argDef
Maps the arguments of the procedure/method to information describing them (default value, textual description)
arglist
List containing the names of all arguments to the procedure.
authorAddress
Mail address of author, as extracted from authorName.
authorName
Name of author, may contain a mail-address too. Specified via @author.
comment
Description of procedure, as given by @comment.
danger
Description of dangers in usage of the procedure, as given by @danger.
keywords
List of keywords associated to the procedure (by @index).
note
Notes about usage of the procedure, as given by @note.
result
Description of procedure result if any.

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: aThe 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: aThe 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: categoryEither crossref or desc.
Argument: errortextA description of the problem.
Argument: urlReference to the place of the problem.

authorSet (author)

Called by the containing file or class to propagate its author information.
Argument: authorAuthor of containing file.

completeKwIndex (phrases)

Called by the containing file (or class) to propagate its indexing information.
Argument: phrasesList 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: aThe 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