saker.nest Documentation TaskDoc JavaDoc Packages
Annotation specifying a documentational information for the given element.

The annotation is used to provide documentational information about the element that it is placed on. The annotation contains a value that is the content of the documentation and a format type that specifies how the value should be interpreted.

The annotation can be placed on types, or enumeration fields. In both cases the specified information is associated with the given element. The annotation cannot be used on fields which are not enum constants. (It doesn't produce a compile error, but simply won't work.)

When the annotation is placed on a class that is declared as a build system task, the information will be associated with the task.

Methods
public String
format() default "format.plaintext"
The format of the information specified in value().
public String
The contents of the documentational information.
public abstract String format() default "format.plaintext"
The format of the information specified in value().

Must be one of the FORMAT_* constants in FormattedTextContent.

The format.
public abstract String value()
The contents of the documentational information.
The information.