Package io.quarkus.runtime.annotations

Annotation Interface ConfigDocEnumValue

@Retention(RUNTIME) @Target(FIELD) @Documented public @interface ConfigDocEnumValue
A way to explicitly customize the string displayed in the documentation when listing accepted values for an enum.

Only works when applied to enum values.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
     

  • Element Details

    • value

      String value
      Returns:
      The string displayed in the documentation for this value when listing accepted values for a configuration property of the relevant enum type.