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


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


Written by
Andreas Kupries
Description
Helper procedures used by fileDescription-objects to extract file level documentation and defined entities (procedures, classes).
Depends on
Pool_Base
Keywords
helper procedures, documentation parsing, definition extraction

fd_author (line)

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

fd_comment (line)

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

fd_danger (line)

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

fd_extract_definitions (log file)

extracts the procedure and class definitions contained in the file.
Argument: logreference to logger object.
Argument: filename of the file to scan.
Returns: A 3-element list. First element is list of procedure-, second a list of class-definitions. At last a list of packages the file depends on.&p The first two lists are readable by 'array set', keys are procedure- and class-names. &p Procedure value is a 2-element list containing the list of formal parameters (form usable by 'proc') and the procedures body. Class value is its specification script.

fd_index (line)

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

fd_note (line)

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

fd_see (line)

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

fd_short (line)

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

file_util_init ()

Noop. Just an entrypoint for autoloading.


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