com.machinezoo.stagean (Stagean 1.0.2 API)

Annotation Types Summary
Annotation Type	Description
CompleteApi	Optionally flags code that has finished API.
CompleteCode	Optionally flags code that has finished implementation.
CompleteDocs	Optionally flags code that has finished javadoc.
CompleteTests	Optionally flags code that has finished tests.
DraftApi	Flags code that has unfinished API.
DraftCode	Flags code that has unfinished implementation.
DraftDocs	Flags code that has unfinished javadoc.
DraftTests	Flags code that has unfinished tests.
NoDocs	Flags code that does not have any javadoc at all.
NoTests	Flags code that does not have any tests at all.
StubApi	Flags code that has almost no API.
StubCode	Flags code that has almost no implementation.
StubDocs	Flags code that has almost no javadoc.
StubTests	Flags code that has almost no tests.

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:

No* - if that kind of content does not exist at all
Stub* - if only short placeholder exists
Draft* - if something is unfinished (regardless of how much)
Complete* - if that kind of content is finished (default)

The following kinds of content have predefined annotation types:

*Api - APIs, i.e. signature and semantics of public types and members
*Code - implementation code, i.e. all code behind APIs
*Tests - tests, usually unit tests
*Docs - javadoc, perhaps also external docs (presumably linked from the javadoc)

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.