From ea3af2fb3c98ad2701023f5eb6bed418c81a966d Mon Sep 17 00:00:00 2001 From: Andy Damevin Date: Mon, 18 Sep 2023 10:27:14 +0200 Subject: [PATCH] Add @ConfigDocEnumValue and @ConfigDocDefault to writing-extensions guidee --- docs/src/main/asciidoc/writing-extensions.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/main/asciidoc/writing-extensions.adoc b/docs/src/main/asciidoc/writing-extensions.adoc index 03f0df969bcbd..dddaa383af560 100644 --- a/docs/src/main/asciidoc/writing-extensions.adoc +++ b/docs/src/main/asciidoc/writing-extensions.adoc @@ -1316,6 +1316,11 @@ public interface SomeConfig { } ---- <1> This will generate a configuration map key named `quarkus.some."cache-name"` instead of `quarkus.some."namespace"`. + +It is possible to write a textual explanation for the documentation default value, this is useful when it is generated: `@ConfigDocDefault("explain how this is generated")`. + +`@ConfigDocEnumValue` gives a way to explicitly customize the string displayed in the documentation when listing accepted values for an enum. + ==== ===== Writing section documentation