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


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


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)

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

cd_classvar (line)

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

cd_comment (line)

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

cd_danger (line)

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

cd_extract_definitions (name log spec)

extracts the method, member and option definitions contained in the class-spec.
Argument: namename of class to analyse
Argument: logreference to logger object
Argument: spectcl 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. See fd_extract_definitions for the format of procedure definitions.

cd_index (line)

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

cd_note (line)

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

cd_option (line)

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

cd_see (line)

Process @see commands
Argument: linetail 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: linetail of line containing the command (= the embedded documentation)

class_util_init ()

Noop. Just an entrypoint for autoloading.


Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries