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

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

Class 'fileDescription'

Superclasses

azIndexEntry
problemsAndIndex

Options

package
log
psort
ptable

Methods

public: DependencyList ()
PostProcessInformation ()
WriteClassLinks ()
WriteHeading ()
WriteProcLinks ()
WriteProcedures ()
author ()
authorSet (author)
clear ()
completeKwIndex ()
dependencies (internal)
fileDescription ()
firstLetter ()
getPage ()
keywords ()
problem (proc)
scan ()
write ()
writeProblemPage ()

Membervariables

public: procedures
classes
keywords
comment
danger
note
seeAlso
inline
dependencies
bug
date
version
authorName
authorAddress

Options

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

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.

WriteProcLinks ()

Generate an itemized list of hyperlinks to the descriptions of all procedures contained in this file.

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: author Author of containing package.

clear ()

Overrides problemsAndIndex:clear
Resets state information.

completeKwIndex ()

complete indexing of lower levels

dependencies (internal)

Determines all dependencies of this file.

Argument: internal list 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 ()

Overrides azIndexEntry:firstLetter
Overrides base class functionality (azIndexEntry:firstLetter) to use the first letter of the actual filename as indexing criterium, not the first letter of the path. Except if <o distribution/fsort-fullpath> is set. Then the first letter of the full path is used.

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: proc Handle 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.

Membervariables

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

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

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.

WriteProcLinks ()
Generate an itemized list of hyperlinks to the descriptions of all procedures contained in this file.

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

authorSet (author)
Called by the containing package to propagate its author information.
Argument: author	Author of containing package.

clear ()
Overrides problemsAndIndex:clear Resets state information.

dependencies (internal)
Determines all dependencies of this file.
Argument: internal	list 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 ()
Overrides azIndexEntry:firstLetter Overrides base class functionality (azIndexEntry:firstLetter) to use the first letter of the actual filename as indexing criterium, not the first letter of the path. Except if <o distribution/fsort-fullpath> is set. Then the first letter of the full path is used.

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: proc	Handle of the object registering itself.

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

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