Configuration Properties

Report on configuration properties used in this project.

de.smartics.testdoc.core.TestDocProperty

Provides properties for the configuration of the test doc report.
Property tdoc.testNameUtils
Name TEST_NAME_UTILS_CLASS_NAME
Type java.lang.String
Mandatory true
Description The name of a class that implements to handle names found in test cases.

The implementation is required to provide a public no-args constructor.

Default Value -
Range -

Property tdoc.exporter
Name EXPORT_ADAPTER_CLASS_NAME
Type java.lang.String
Mandatory true
Description The name of a class that implements to handle unit test documentation found by the annotation processor.

The implementation is required to provide a public no-args constructor.

Default Value -
Range -

Property tdoc.exporter.baseDir
Name EXPORT_ADAPTER_BASE_DIR
Type java.lang.String
Mandatory true
Description The path to the directory to export the test documentation fragments to.

This will neglect the de.smartics.testdoc.core.TestDocProperty.EXPORT_ADAPTER_CLASS_NAME property and select a directory based export adapter.

Default Value -
Range -

Property tdoc.processor.quiet
Name PROC_CONF_QUIET
Type java.lang.Boolean
Mandatory true
Description Allows to control the verboseness of the processor.

If tdoc.processor.quiet is set to true, the processor will be less verbose.

Default Value false
Range -