Stagean » Javadoc

Skip navigation links

Package com.machinezoo.stagean

This package contains annotation types that can be used to document current development stage on type or member level.

See: Description

Package com.machinezoo.stagean Description

This package contains annotation types that can be used to document current development stage on type or member level. Hand-edited annotations can complement the sometimes inaccurate coverage tools. All annotations are visible in javadoc

Four development stages (or levels of quality) are recognized:

The following kinds of content have predefined annotation types:

There are no NoCode and NoApi annotation, because they have no meaning and DraftCode/DraftApi annotations should be used in their place instead. Nuances in meaning can be clarified in string parameter that is taken by all annotations. Applications/libraries are free to define their own annotation types, but the above listed ones are expected to be supported by scanning tools.

Annotations have the default retention RetentionPolicy.CLASS. Tools can scan for these annotations in sources, during annotation processing, and in compiled class files. Annotations also show up in javadoc for annotated code, so that users are informed about development stage of the class/method they are using.

Skip navigation links

Copyright © 2020 Robert Važan. All rights reserved.