Package org.apache.flink.annotation.docs
Class Documentation
- java.lang.Object
-
- org.apache.flink.annotation.docs.Documentation
-
public final class Documentation extends Object
Collection of annotations to modify the behavior of the documentation generators.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDocumentation.ExcludeFromDocumentationAnnotation used on config option fields or REST API message headers to exclude it from documentation.static classDocumentation.ExecModeThe execution mode the config works for.static interfaceDocumentation.OverrideDefaultAnnotation used on config option fields to override the documented default.static interfaceDocumentation.SectionAnnotation used on config option fields to include them in specific sections.static classDocumentation.SectionsConstants for section names.static interfaceDocumentation.SuffixOptionAnnotation used on config option fields or options class to mark them as a suffix-option; i.e., a config option where the key is only a suffix, with the prefix being dynamically provided at runtime.static interfaceDocumentation.TableOptionAnnotation used on table config options for adding meta data labels.
-