Package space.arim.dazzleconf.annote

Annotation Type ConfHeader

@Retention(RUNTIME) @Target(TYPE) public @interface ConfHeader
Allows specifying the comment header on a top level configuration or a comment on a sub section.

If the target of this annotation is used as a top level config, value() becomes the comment header of the configuration.

If the target of this annotation is used as a subsection, the value of this annotation instead becomes a comment on that specific subsection. Note the presence of ConfComments on the method declaring the subsection will override this annotation.
Author:
A248

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
    The comment header itself.

  • Element Details

    • value

      String[] value
      The comment header itself. Each string is on its own line
      Returns:
      the comment header