org.apache.flink.docs.configuration

Class ConfigOptionsDocGenerator

java.lang.Object

org.apache.flink.docs.configuration.ConfigOptionsDocGenerator

public class ConfigOptionsDocGenerator
extends Object

Class used for generating code based documentation of configuration parameters.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) This method generates html tables from set of classes containing ConfigOptions.

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)
                 throws Exception

This method generates html tables from set of classes containing ConfigOptions.

For each class 1 or more html tables will be generated and placed into a separate file, depending on whether the class is annotated with ConfigGroups. The tables contain the key, default value and description for every ConfigOption.

One additional table is generated containing all ConfigOptions that are annotated with Documentation.Section.

Parameters:

args - [0] output directory for the generated files [1] project root directory

Throws:

Exception