Module io.annot8.api
Package io.annot8.api.settings

Annotation Type Description

  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface Description
    Describes a parameter within a settings class.

    This should be set on the get method for a parameter, and it may generally be assumed that there is a corresponding set method.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      A description of this parameter

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultValue
      Default value of this parameter

    • Element Detail

      • value

        String value
        A description of this parameter
        Returns:
        description

      • defaultValue

        String defaultValue
        Default value of this parameter
        Returns:
        default value of this parameter
        Default:
        ""