Package de.smartics.analysis.javadoc

Provides the interfacing classes with the Javadoc tool.

See:
Description

Interface Summary

Filter	A filter to remove unwanted Javadoc information from a doclet.
JavadocCollector	Defines the interface to collect specific information from a Java source tree.

Class Summary

CollectorContext	The context of a collector execution.
CollectorContextManager	The singleton provides the collector context used to provide information to the collector doclet.
CollectorDoclet	The doclet to interface with the Javadoc tool.
Console	Encapsulates the information returned to the console.
DefaultJavadocCollector	The base implementation to interface with the Javadoc tool.
FileNameUtils	Utilities to work on file names and files.
JavadocArgumentsUtils	Utility class to map information from a project configuration to a map of arguments that can be passed to the Javadoc tool.
JavadocLoader	Loader for Javadoc information for a class.
JavadocUtils	Utilities to communicate with the Javadoc tool.

Exception Summary

JavadocException

Signals problems reported by the Javadoc tool.

Package de.smartics.analysis.javadoc Description

Provides the interfacing classes with the Javadoc tool.

The main artifact of this package is the interface JavadocCollector and its default implementation DefaultJavadocCollector. These artifacts adapt to the interface the Javadoc tool provides and call the Javadoc tool.

The Javadoc tool in turn uses the CollectorDoclet which uses the configured filter to collect the Javadoc information from those elements that pass the filter.

The communication between the CollectorDoclet and DefaultJavadocCollector is done via a thread-local static context implemented by CollectorContext and the CollectorContextManager (the latter is the static context, the former an information bundle to hold the information for the CollectorDoclet to parse and the result from the parsing for the DefaultJavadocCollector to retrieve).

Since:

1.0