PackageDescription: SmalltalkDoc-Template


Smalltalk Doc - Template

Last published: June 27, 2003 by 'markr'

Defines 0 Classes
Extends 0 Classes

SmalltalkDoc is a Web application that extracts documentation for classes, name spaces, and packages from a Store repository.

SmalltalkDoc-Template is an empty package, used to document and test a number of additional component properties used by SmalltalkDoc. The additional properties are: summary, deprecated, description, keywords, documentation, usage, limitations, author, copyright, and license. These properties, if found, will be displayed in the summaries generated by SmalltalkDoc.

The keywords property is used to for indexing and to generate the SmalltalkDoc "Overview". Keywords is expected to be a string of keywords or key-phrases, separated by semi-colons. The first key-phrase is the one that gets displayed as the top level of the overview.

The "public" property is used when including components in the "Overview". Only those components that include this property will be shown in the overview.