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

-parent: Handle of object containing the procedure. Can be a file or class (fileDescription, classDescription).
-args: List containing the names of all procedure arguments.
-body: Script containing the body of the procedure definition.
-table: Boolean flag. If set procedure documentation is written as table.
default value: 0
-log: Handle of the syslogConnection object to use for logging
-usage: Used to distinguish between class and member methods. Allowed values are class and member. The latter is the default.
default value: member
-visibility: One of public, protected and private. Determines the visibility of the method outside of the class.
default value: public

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.

GetDescription ()
Retrieves the description of the procedure. May prepend it with inheritance information (overridden base classes). The string is not in printable form.
Returns: A string.

GetInhReferences ()
Computes inheritance information for the method.
Returns: A string.

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.

WriteSimpleArglist ()
Returns: a string containing the list of argument for the procedure, without descriptions, etc.

WriteStandard ()
Generates the formatted text describing the procedure. This method generates a definition list.

addProblem (category errortext url)
Overrides problems:addProblem Overrides 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 ()
Overrides azIndexEntry:firstLetter
Returns: the first letter of the name of this index entry.

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.

pPage ()
Overrides problems: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.

title (link)
Generate the title line of the description.
Argument: link (= 0)	Boolean flag, optional. If set the generated line will not contain the visibility information and the name of the procedure/method will be a link to its description.

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.

Membervariables

keywords: List of keywords associated to the procedure (by @index).
comment: Description of procedure, as given by @comment.
danger: Description of dangers in usage of the procedure, as given by @danger.
note: Notes about usage of the procedure, as given by @note.
result: Description of procedure result if any.
arglist: List containing the names of all arguments to the procedure.
anchor: Name of the anchor associated to the procedure.
authorName: Name of author, may contain a mail-address too. Specified via @author.
authorAddress: Mail address of author, as extracted from authorName.
bug: Description of bugs associated to the procedure.
date: Dates associated with the procedure.
version: Version information associated with the procedure.
example: Example associated with the procedure.
argDef: Maps the arguments of the procedure/method to information describing them (default value, textual description)
inhInfo: Information about inheritance (if this object describes a method in a class). Already formatted for display.
initial value: @@

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

Class 'procDescription'

Options

Methods

Anchor ()

ArgDescription (a)

ArgName (a)

GetDescription ()

GetInhReferences ()

PostProcessInformation ()

ProcDescription ()

ReportSpamArguments ()

WriteArgumentsAsList ()

WriteArgumentsAsTable ()

WriteAsTable ()

WriteSimpleArglist ()

WriteStandard ()

addProblem (category errortext url)

authorSet (author)

completeKwIndex (phrases)

firstLetter ()

getPage ()

hasArgument (a)

keywords ()

pPage ()

procDescription ()

scan ()

title (link)

write ()

Membervariables

getPage ()
Returns: The url of the page containing the procedure description.

keywords ()
Returns: The list of keywords this procedure is indexed under.