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

Description (short): procDescription helper procedures.
Written by: Andreas Kupries
Description: Helper procedures used by procDescription to extract procedure level documentation.
Depends on: Pool_Base
Keywords: helper procedures, documentation parsing, definition extraction

pd_argument (line)
pd_author (line)
pd_bug (line)
pd_comment (line)
pd_danger (line)
pd_date (line)
pd_example (line)
pd_index (line)
pd_note (line)
pd_result (line)
pd_util_init ()
pd_version (line)

pd_argument (line)

Process @argument, @a commands

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

pd_author (line)

Process @author commands

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

pd_bug (line)

Process @bug, @b commands

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

pd_comment (line)

Process @comment, @c commands

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

pd_danger (line)

Process @danger, @d commands

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

pd_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.

pd_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.

pd_index (line)

Process @index, @i commands

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

pd_note (line)

Process @note, @n commands

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

pd_result (line)

Process @result, @r commands

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

pd_util_init ()

Noop. Just an entrypoint for autoloading.

pd_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.

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

pd_argument (line)
Process @argument, @a commands
Argument: line	tail of line containing the command (= the embedded documentation)

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

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

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

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

pd_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.

pd_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.

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

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

pd_result (line)
Process @result, @r commands
Argument: line	tail of line containing the command (= the embedded documentation)

pd_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.