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

Description (short): Packages
Written by: Andreas Kupries
Description: Management of packages and their contents.
Keywords: packages

Class 'packageDescription'

Superclasses

indexBaseEntry
problems

Options

log
dir

Methods

public: DependencyList ()
ReportNumber (n singular plural)
TrackDirectory (o oldValue)
authorSet (author)
clear ()
completeDatabase (author)
completeKwIndex ()
dependencies (internal)
getDescription ()
getPage ()
packageDescription ()
scan ()
write ()
writeProblemPage ()

Membervariables

public: files
authorName
authorAddress
desc
phrases
dependencies

Options

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

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: n The number of found items.

Argument: singular The singular form of the found entities.

Argument: plural The 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: o The name of the changed option, here always -dir.

Argument: oldValue The value of the option before the change. Ignored here.

authorSet (author)

Called by distribution to propagate author information to packages and below.

Argument: author The author of the distribution.

clear ()

Overrides problems:clear
Resets state information.

completeDatabase (author)

Complete the information about the package.

Argument: author The author of the distribution.

completeKwIndex ()

Complete the indexing of lower levels

dependencies (internal)

Determines all dependencies of this package

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

packageDescription ()

Constructor. Just used to initialize the entity information.

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.

Membervariables

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

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 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: n	The number of found items.
Argument: singular	The singular form of the found entities.
Argument: plural	The 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: o	The name of the changed option, here always -dir.
Argument: oldValue	The value of the option before the change. Ignored here.

authorSet (author)
Called by distribution to propagate author information to packages and below.
Argument: author	The author of the distribution.

completeDatabase (author)
Complete the information about the package.
Argument: author	The author of the distribution.

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

getPage ()
Returns: The url of the page containing the package description.

packageDescription ()
Constructor. Just used to initialize the entity information.

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.