Package org.openquark.cal.caldoc

Provides support for converting CALDoc comments to various formats (HTML, pretty-printed text, Javadoc).

See:
Description

Interface Summary

FileGenerator

This interface represents a rudimentary file generator for creating text files.

Class Summary

CALDocToHTMLUtilities	This is a utility class containing helper methods for converting CALDoc into properly formatted HTML.
CALDocToHTMLUtilities.CALFeatureCrossReferenceGenerator	Abstract base class for a CrossReferenceHTMLGenerator implementation that is built to handle cross-references expressed as CALFeatureNames.
CALDocToHTMLUtilities.CrossReferenceHTMLGenerator	Abstract base class for a generator capable of generating appropriate HTML for cross-references.
CALDocToHTMLUtilities.CrossReferenceHTMLStringGenerator	Abstract base class for a generator capable of generating appropriate HTML text for cross-references.
CALDocToJavaDocUtilities	This is a utility class containing helper methods for converting CALDoc into Javadoc.
CALDocToJavaDocUtilities.JavadocCrossReferenceGenerator	An abstract class representing a cross-reference generator that can generate Javadoc references.
CALDocTool	This class represents the public interface to the HTML documentation generator.
CALDocTool.Launcher	This class encapsulates a running instance of the CALDocTool command line interface.
CALDocToTextUtilities	This is a utility class containing helper methods for converting CALDoc into pretty-printed text.
CALDocToTooltipHTMLUtilities	This is a utility class containing helper methods for converting CALDoc into properly formatted HTML for use in tooltips in IDEs.
FileSystemFileGenerator	This class implements a rudimentary file generator for creating text files on the file system.
HTMLDocumentationGeneratorConfiguration	This class encapsulates the configuration options for the HTML documentation generator.

Package org.openquark.cal.caldoc Description

Provides support for converting CALDoc comments to various formats (HTML, pretty-printed text, Javadoc).

Key classes in this package

CALDocTool

This class provides both the command line interface for the HTML documentation generator, and a programmatic interface for launching the tool with various options (as represented by HTMLDocumentationGeneratorConfiguration).

CALDocToHTMLUtilities and CALDocToTextUtilities

These two classes provide the ability to convert CALDoc comments into HTML and pretty-printed text respectively.