Package org.apache.polaris.docs

Interface ConfigDocs

public interface ConfigDocs

Contains annotations for :polaris-config-doc-generator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static @interface	ConfigDocs.ConfigItem	Define the "section" in which the config option appears.
static @interface	ConfigDocs.ConfigPageGroup	For properties-configs, declares a class containing configuration constants for "properties" and gives it a page name.
static @interface	ConfigDocs.ConfigPropertyName	For smallrye-configs, gives map-keys a name that appears as a placeholder in the fully qualified config name in the generated docs.