Package org.apache.polaris.docs

Annotation Interface ConfigDocs.ConfigItem

Enclosing interface:

ConfigDocs

@Target({FIELD,METHOD})
@Retention(SOURCE)
public static @interface ConfigDocs.ConfigItem

Define the "section" in which the config option appears.

For properties-configs, this declares that a property constant field appears in the generated markdown files.

For smallrye-configs, this declares that a property appears under a different "prefix".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	section	The name of the "section" in which this constant field shall appear.
boolean	sectionDocFromType	For smallrye-configs only: the section docs are taken from property type's javadoc.

Element Details

section

String section

The name of the "section" in which this constant field shall appear. The name of the generated markdown file will "end" with this name.

Default:

""

sectionDocFromType

boolean sectionDocFromType

For smallrye-configs only: the section docs are taken from property type's javadoc.

Default:

false