PackageDescription: SmalltalkDoc Development(Bundle)


Smalltalk Doc Development

Last published: August 16, 2004 by 'rdemers'

No bundle comment found. Component comments follow

PackageDescription: StDoc Namespaces

This package defines the namespaces used by System Documentation.

PackageDescription: StDoc Extensions

This package contains the extensions to system classes used by System Documentation.

PackageDescription: StDoc Extension Tests

This package contains SUnit test cases for the extensions to system classes used by System Documentation.

PackageDescription: StDoc Element Framework

This package defines the abstract classes that create a framework for the XML and XHTML elements of System Documentation. Abstract subclasses of Element are defined in terms of the contents an instance can have.

PackageDescription: StDoc Element Frametests

This package defines the SUnit test cases for the System Documentation Element Framework.

PackageDescription: StDoc Domain Framework

This package defines the abstract classes that define a framework for the System Documentation domain model.
* CoreDoc is the most abstract class of documentaion objects.
* VersionedDoc is the abstract subclass of CoreDocs that are versioned in Store.
* ComponentDoc is the abstract subclass of VersionedDocs that are managed as separate components.

Class SystemDocumentation serves two purposes:
* Its class methods provide an external interface (API) to the services of System Documentation. This API is intended primarily for use by other tools in the IDE.
* Instances of class SystemDocumentation serve as the outermost (or root) element of all XML manisfestations of stored or exported System documents.

PackageDescription: StDoc Domain Frametests

This package defines SUnit test cases for the System Documentation domain framework.


* All TestXxxDoc classes are subclasses of DocTestCase.
* The ShamXxxDoc classes are concrete subclasses of the domain framework classes. They are defined for SUnit testing of their superclasses.

PackageDescription: StDoc Domain

This package defines the classes of the System Documentation domain model. These classes are subclassed from the System Documentation Domain Framework classes. In general, the relationships among these objects parallel the relationships of the similarly named Smalltalk objects.

Smalltalk Domain Assumptions:
-- A Bundle knows the names of the bundles and packages it contains, but stores only its own BundleDoc.
-- A Package knows the names of the namespaces, classes, methods and shared variables it contains, but stores only its own PackageDoc.
-- A Namespace knows the names of the shared variables it contains, but stores only its own NamespaceDoc.
-- A Shared Variable stores its own VariableDoc.
-- A Class knows the names of the variables, protocols and methods it defines, and stores its own ClassDoc.
-- A ClassDoc includes the ProtocolDocs of its class protocols and instance protocols.
-- A ClassDoc includes the VariableDocs of its class instance variables and instance variables.
-- A ClassDoc includes the EventDocs for all of the events that the class triggers.
-- An EventDoc includes the VariableDocs of its arguments.
-- A Method stores its own MethodDoc.
-- A MethodDoc includes the VariableDocs of its arguments and its return variables.
-- The exceptions signaled by a method are documented by the ClassDocs of the Exception classes.

PackageDescription: StDoc Domain Tests

This package defines the SUnit test cases for the System Documentation domain model.

PackageDescription: StDoc XML Parser

This package defines the classes that construct System Documentation domain objects from parsed XML.

This is not a fully general XML-to-Objects deserializer; however, it is suitable for generating objects from XML for a predetermined domain model. See the comment of class Constuctor for more details.

PackageDescription: StDoc XML Parser Tests

This package defines the SUnit test cases for the System Documentation XML Parser package.

PackageDescription: StDoc Browser UI

This package defines the classes of the System Documentation code-tool of the System Browser.

Class DocumentationTool and DocumentationToolSelectionPolicy are used with the System Browser framework to provide a "Documentation" tab in the Browser.

For a simple test application that does not use the System Browser, look at StDoc.DemoApp.