Module com.erudika.para.core
Package com.erudika.para.core.annotations

Annotation Type Documented

@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface Documented
A generic annotation intended to be used for attaching documentation metadata to the getter methods of configuration properties.
Author:
Alex Bogdanovski [[email protected]]

  • Element Details

    • category

      String category
      Returns:
      the category which this property is part of.
      Default:
      "main"

    • description

      String description
      Returns:
      basic description of the config property.
      Default:
      ""

    • type

      Class<?> type
      Returns:
      the data type of the config value.
      Default:
      java.lang.String.class

    • value

      String value
      Returns:
      a default or suggested value.
      Default:
      ""

    • identifier

      String identifier
      Returns:
      the config property key (identifier).
      Default:
      ""

    • position

      int position
      Returns:
      position number for sorting.
      Default:
      2147483647

    • tags

      String[] tags
      Returns:
      additional tags.
      Default:
      {}