Package org.apache.flink.annotation.docs

Class Summary

Class	Description
Documentation	Collection of annotations to modify the behavior of the documentation generators.
Documentation.Sections	Constants for section names.
FlinkJsonSchema	Annotations for auto-generating a documentation of json payloads.

Enum Summary

Enum	Description
Documentation.ExecMode	The execution mode the config works for.

Annotation Types Summary

Annotation Type	Description
ConfigGroup	A class that specifies a group of config options.
ConfigGroups	Annotation used on classes containing config options that enables the separation of options into different tables based on key prefixes.
Documentation.ExcludeFromDocumentation	Annotation used on config option fields or REST API message headers to exclude it from documentation.
Documentation.OverrideDefault	Annotation used on config option fields to override the documented default.
Documentation.Section	Annotation used on config option fields to include them in specific sections.
Documentation.SuffixOption	Annotation 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.
Documentation.TableOption	Annotation used on table config options for adding meta data labels.
FlinkJsonSchema.AdditionalFields	This allows documenting a class that supports setting dynamic properties of a certain type.