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


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


Written by
Andreas Kupries
Description
Management of files and their contents (classes and procedures)
Keywords
files

Class 'fileDescription'

Superclasses
azIndexEntry, problemsAndIndex
Options
log, package, psort, ptable
Membervariables
authorAddress, authorName, classes, comment, danger, dependencies, inline, keywords, note, procedures, seeAlso
Methods
DependencyList, PostProcessInformation, WriteClassLinks, WriteHeading, WriteProcedures, author, authorSet, clear, completeKwIndex, dependencies, fileDescription, firstLetter, getPage, keywords, problem, scan, write, writeProblemPage

-log
Handle of the syslogConnection object to use for logging
-package
Handle of the packageDescription object containing the file
-psort
Boolean flag. Setting causes the generation of an alphabetically sorted list of procedure documentation.
-ptable
Boolean flag. Setting it causes the usage of tables for procedure documentation. A definition list is used else.

authorAddress
Mail address of author, as extracted from authorName.
authorName
Name of author, may contain a mail-address too. Specified via @author.
classes
List of classes contained in the file. Contains the handles of classDescription objects.
comment
Description of file, as given by @comment.
danger
Description of dangers in usage of the file, as given by @danger.
dependencies
List of packages required by the file.
inline
Boolean flag. Setting it will cause the inlining of the documentation for contained classes into the file page.
keywords
List of keywords associated to the class (by @index).
note
Notes about usage of the file, as given by @note.
procedures
List of procedures contained in the file. Contains the handles of procDescription objects.
seeAlso
Crossreferences as given by @see.

DependencyList ()

Internal method, generates a string containing references to the packages required by the file.
Returns: A string containing a comma separated list of package names, each a hyperlink to a location describing the it.

PostProcessInformation ()

Called to streamline the extracted embedded documentation.

WriteClassLinks ()

Generate an itemized list of hyperlinks to the descriptions of all classes contained in this file. Used only if classes are outlined.

WriteHeading ()

Generates the header part of a file description.

WriteProcedures ()

Generates the descriptions for all procedures defined in this file. Uses different separator rules dependent on the style of procedure descriptions (table vs. definition list).

author ()

Returns: The author of the file.

authorSet (author)

Called by the containing package to propagate its author information.
Argument: authorAuthor of containing package.

clear ()

Resets state information.

completeKwIndex ()

complete indexing of lower levels

dependencies (internal)

Determines all dependencies of this file.
Argument: internallist of packages distributed here, to be removed from all dependency lists.
Returns: List containing all dependencies of this file.

fileDescription ()

Constructor. Initializes the parser functionality in lib/fileParse.tcl.

firstLetter ()

Overides base classs functionality (azIndexEntry:firstLetter) to use the first letter of the actual filename as indexing criterium, not the first letter of the path.

getPage ()

Returns: The url of the page containing the file description.

keywords ()

Returns: The list of keywords this file is indexed under.

problem (proc)

Called by procedures to register them as incompletely documented. This is done, additionally the containing file (this one) is registered as a problem too.
Argument: procHandle of the object registering itself.

scan ()

Scans the file for embedded documentation and definitions (procedures, classes).

write ()

Generates the formatted text describing the file.

writeProblemPage ()

Writes a page containing the detailed problem description of this file.


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