Overview

This library provides annotations to add documentation meta data to Java classes. It is part of project projectdoc.

The annotations allow to provide documentation information at Java source code level. These annotations are analyzed by tools to generated indices, links to related classes, etc. in the auto generated documentation. The documentation is targeted to software developers that either use a software library or framework or maintain an existing code base. The documentation may also provide information for other audiences or serve as a base of information for technical writers.

This adheres to the notion that documentation should be as close to the code as possible. So this is part of the endeavor to produce living documentation.

This library only provides annotations and no parsers that evaluate the annotated classes.

Annotations

The following list of annotations is provided by this library.

1. Document - base annotation to provide several pieces of meta data information about the annotated element.
2. Parent - a reference to a parent of the annotated element.
3. Category - a hierarchical category the annotated element belongs to.
4. Tag - a collection of tags that are associated with the annotated element.