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 @interface	Documentation.ExcludeFromDocumentation	Annotation used on config option fields or REST API message headers to exclude it from documentation.
static enum	Documentation.ExecMode	The execution mode the config works for.
static @interface	Documentation.OverrideDefault	Annotation used on config option fields to override the documented default.
static @interface	Documentation.Section	Annotation used on config option fields to include them in specific sections.
static final class	Documentation.Sections	Constants for section names.
static @interface	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.
static @interface	Documentation.TableOption	Annotation used on table config options for adding meta data labels.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait