File 'lib/classParse.tcl' (part of 'AutoDOC')

Description (short): classDescription helper procedures.
Written by: Andreas Kupries
Description: Helper procedures used by classDescription-objects to extract class level documentation and defined entities (methods, options, members).
Depends on: Pool_Base
Keywords: helper procedures, documentation parsing, definition extraction

cd_author (line)
cd_bug (line)
cd_classvar (line)
cd_comment (line)
cd_danger (line)
cd_date (line)
cd_example (line)
cd_extract_definitions (name log itk_opt_alias spec)
cd_index (line)
cd_note (line)
cd_option (line)
cd_see (line)
cd_var (line)
cd_version (line)
class_util_init ()

cd_author (line)

Process @author commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_bug (line)

Process @bug, @b commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_classvar (line)

Process @classvar, @cv commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_comment (line)

Process @comment, @c commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_danger (line)

Process @danger, @d commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_date (line)

Process @date commands. No shortcut, @d is already used for @danger.

Argument: line tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output.

cd_example (line)

Process @example, @ex commands.

Argument: line tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output. Leading whitespace is preserved, trailing whitespace not.

cd_extract_definitions (name log itk_opt_alias spec)

extracts the method, member and option definitions contained in the class-spec.

Argument: name name of class to analyse

Argument: log reference to logger object

Argument: itk_opt_alias See <o distribution/itk-opt-alias>.

Argument: spec tcl code containing the specification to scan.

Returns: A 5-element list. First element is a list of procedure-definitions, followed by the lists of options, members and superclasses. At last the list of packages the class depends on. Procedure definitions are keyed by name and contain argument list, body, visibility and class/object flag ([incr Tcl] allows class methods and variables). See fd_extract_definitions too for the basic format of procedure definitions.

cd_index (line)

Process @index, @i commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_note (line)

Process @note, @n commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_option (line)

Process @option, @o commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_see (line)

Process @see commands

Argument: line tail of line containing the command (= the embedded documentation)

cd_var (line)

Process @var, @v, @member, @m commands. The latter 2 are old-style commands and will be obsolete in future releases.

Argument: line tail of line containing the command (= the embedded documentation)

cd_version (line)

Process @version commands. No shortcut, @v is already used for @var.

Argument: line tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output.

class_util_init ()

Noop. Just an entrypoint for autoloading.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

cd_author (line)
Process @author commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_bug (line)
Process @bug, @b commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_classvar (line)
Process @classvar, @cv commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_comment (line)
Process @comment, @c commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_danger (line)
Process @danger, @d commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_date (line)
Process @date commands. No shortcut, @d is already used for @danger.
Argument: line	tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output.

cd_example (line)
Process @example, @ex commands.
Argument: line	tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output. Leading whitespace is preserved, trailing whitespace not.

cd_extract_definitions (name log itk_opt_alias spec)
extracts the method, member and option definitions contained in the class-spec.
Argument: name	name of class to analyse
Argument: log	reference to logger object
Argument: itk_opt_alias	See <o distribution/itk-opt-alias>.
Argument: spec	tcl code containing the specification to scan.
Returns: A 5-element list. First element is a list of procedure-definitions, followed by the lists of options, members and superclasses. At last the list of packages the class depends on. Procedure definitions are keyed by name and contain argument list, body, visibility and class/object flag ([incr Tcl] allows class methods and variables). See fd_extract_definitions too for the basic format of procedure definitions.

cd_index (line)
Process @index, @i commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_note (line)
Process @note, @n commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_option (line)
Process @option, @o commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_see (line)
Process @see commands
Argument: line	tail of line containing the command (= the embedded documentation)

cd_var (line)
Process @var, @v, @member, @m commands. The latter 2 are old-style commands and will be obsolete in future releases.
Argument: line	tail of line containing the command (= the embedded documentation)

cd_version (line)
Process @version commands. No shortcut, @v is already used for @var.
Argument: line	tail of line containing the command (= the embedded documentation). Each line in the input will be on a separate line in the output.