org.apache.flink.configuration

Class ConfigOptionsDocGenerator

java.lang.Object

org.apache.flink.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 IOException,
                        ClassNotFoundException

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.

Parameters:

args - first argument is output path for the generated files, second argument is full package name containing classes with ConfigOption

Throws:

IOException

ClassNotFoundException