Package org.apache.flink.annotation.docs

Annotation Type Documentation.Section

  • @Target(FIELD)
@Retention(RUNTIME)
@Internal
public static @interface Documentation.Section
    Annotation used on config option fields to include them in specific sections. Sections are groups of options that are aggregated across option classes, with each group being placed into a dedicated file.

    The position() argument controls the position in the generated table, with lower values being placed at the top. Fields with the same position are sorted alphabetically by key.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int position
      The relative position of the option in its section.
      String[] value
      The sections in the config docs where this option should be included.

    • Element Detail

      • value

        String[] value
        The sections in the config docs where this option should be included.
        Default:
        {}

      • position

        int position
        The relative position of the option in its section.
        Default:
        2147483647