Package io.quarkus.runtime.annotations

Annotation Interface ConfigDocSection

@Documented @Retention(RUNTIME) @Target({FIELD,PARAMETER,METHOD}) public @interface ConfigDocSection
A marker indicating that the configuration member documentation must be generated as a section.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    generated
    If we should generate a specific file for this section.

  • Element Details

    • generated

      boolean generated
      If we should generate a specific file for this section.

      We used to do it for all config groups before but it's counterproductive. The new annotation processor only generates a file for a config group if this is true.

      Default:
      false