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


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


Written by
Andreas Kupries
Description
Management of packages and their contents.
Keywords
packages

Class 'packageDescription'

Superclasses
indexBaseEntry, problems
Options
dir, log
Membervariables
authorAddress, authorName, dependencies, desc, files, phrases
Methods
DependencyList, ReportNumber, TrackDirectory, authorSet, clear, completeDatabase, completeKwIndex, dependencies, getDescription, getPage, scan, write, writeProblemPage

-dir
Path to directory containing the package.
-log
Handle of syslogConnection object to use for logging

authorAddress
Mail address of author, as extracted from authorName.
authorName
Name of author, may contain a mail-address too. Specified via @author.
dependencies
List of packages required by the class.
desc
Description of the package.
files
List of files contained in the package. They are given as handles to their fileDescription objects.
phrases
List of keywords associated to the class.

DependencyList ()

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

ReportNumber (n singular plural)

Report the number of found entities to the log.
Argument: nThe number of found items.
Argument: singularThe singular form of the found entities.
Argument: pluralThe plural form of the found entities.

TrackDirectory (o oldValue)

Internal method. Called by the generic option tracking mechanism for any change made to dir. Causes a rereading of the package description in the newly specified directory.
Argument: oThe name of the changed option, here always -dir.
Argument: oldValueThe value of the option before the change. Ignored here.

authorSet (author)

Called by distribution to propagate author information to packages and below.
Argument: authorThe author of the distribution.

clear ()

Resets state information.

completeDatabase (author)

Complete the information about the package.
Argument: authorThe author of the distribution.

completeKwIndex ()

Complete the indexing of lower levels

dependencies (internal)

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

getDescription ()

Parses package description file 'pkg.doc'.

getPage ()

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

scan ()

Scan package for files containing tcl-code (.tcl, .cls extensions are recognized)

write ()

Generates the formatted text describing the package.

writeProblemPage ()

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


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