Package org.oddjob.arooa.beandocs

package org.oddjob.arooa.beandocs

Provide classes for creating the Job documentation. Currently, only the Oddjob reference, (see the oj-doc module) provides documentation. One day documentation will be available interactively in the Designer.

Related Packages

Package	Description
org.oddjob.arooa	Arooa stands for A Rip Off Of Ant, and provides ant like configuration.
org.oddjob.arooa.beandocs.element	Elements break a document section into it's various parts so that documentation can be produced in various formats such as HTML and MarkDown.

Class	Description
ArooaDoc	A group of BeanDoc normally for either Values or Components.
ArooaDocFactory	Something that can create ArooaDoc.
BeanDoc	Documentation for a bean.
BeanDocArchive	Something that is able to provide BeanDocs for jobs and types.
ExampleDoc
MappingsBeanDoc	Helper class to provide MappingsContents for the common mappings implementations.
MappingsContents	This is essentially a place holder for things to come.
PropertyDoc	Provides the documentation for the property of a bean.
PropertyDoc.Access
PropertyDoc.Multiplicity
SessionArooaDocFactory	An ArooaDocFactory that creates a set of ArooaDoc from an ArooaSession.
WriteableArooaDoc
WriteableBeanDoc
WriteableExampleDoc
WriteablePropertyDoc	Allows documentation for a property to be accumulated via setters.