Package org.apache.flink.annotation.docs

Annotation Type Documentation.ExcludeFromDocumentation

@Target({FIELD,TYPE})
@Retention(RUNTIME)
@Internal
public static @interface Documentation.ExcludeFromDocumentation

Annotation used on config option fields or REST API message headers to exclude it from documentation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	value	The optional reason why it is excluded from documentation.

Element Detail

value

String value

The optional reason why it is excluded from documentation.

Default:

""