Allow to set default value for config options with AsciiDoc attributes for documentation

See #51024 (comment)

Author: wjglerum

core/processor/src/main/java/io/quarkus/annotation/processor/documentation/config/discovery/DiscoveryConfigProperty.java

@@ -13,6 +13,7 @@ public class DiscoveryConfigProperty {
     private final SourceElementType sourceElementType;
     private final String defaultValue;
     private final String defaultValueForDoc;
+    private final boolean escapeDefaultValueForDoc;
     private final Deprecation deprecation;
     private final String mapKey;
     private final boolean unnamedMapKey;
@@ -24,8 +25,8 @@ public class DiscoveryConfigProperty {
 
     public DiscoveryConfigProperty(String path, String sourceType, String sourceElementName,
             SourceElementType sourceElementType,
-            String defaultValue,
-            String defaultValueForDoc, Deprecation deprecation, String mapKey, boolean unnamedMapKey,
+            String defaultValue, String defaultValueForDoc, boolean escapeDefaultValueForDoc,
+            Deprecation deprecation, String mapKey, boolean unnamedMapKey,
             ResolvedType type, boolean converted, boolean enforceHyphenateEnumValue,
             boolean section, boolean sectionGenerated) {
         this.path = path;
@@ -34,6 +35,7 @@ public DiscoveryConfigProperty(String path, String sourceType, String sourceElem
         this.sourceElementType = sourceElementType;
         this.defaultValue = defaultValue;
         this.defaultValueForDoc = defaultValueForDoc;
+        this.escapeDefaultValueForDoc = escapeDefaultValueForDoc;
         this.deprecation = deprecation;
         this.mapKey = mapKey;
         this.unnamedMapKey = unnamedMapKey;
@@ -68,6 +70,10 @@ public String getDefaultValueForDoc() {
         return defaultValueForDoc;
     }
 
+    public boolean isEscapeDefaultValueForDoc() {
+        return escapeDefaultValueForDoc;
+    }
+
     public Deprecation getDeprecation() {
         return deprecation;
     }
@@ -150,6 +156,7 @@ public static class Builder {
         private final ResolvedType type;
         private String defaultValue;
         private String defaultValueForDoc;
+        private boolean escapeDefaultValueForDoc = true;
         private Deprecation deprecation;
         private String mapKey;
         private boolean unnamedMapKey = false;
@@ -180,6 +187,11 @@ public Builder defaultValueForDoc(String defaultValueForDoc) {
             return this;
         }
 
+        public Builder escapeDefaultValueForDoc(boolean escapeDefaultValueForDoc) {
+            this.escapeDefaultValueForDoc = escapeDefaultValueForDoc;
+            return this;
+        }
+
         public Builder deprecated(String since, String replacement, String reason) {
             this.deprecation = new Deprecation(since, replacement, reason);
             return this;
@@ -220,7 +232,7 @@ public DiscoveryConfigProperty build() {
             }
 
             return new DiscoveryConfigProperty(name, sourceType, sourceElementName, sourceElementType, defaultValue,
-                    defaultValueForDoc,
+                    defaultValueForDoc, escapeDefaultValueForDoc,
                     deprecation, mapKey, unnamedMapKey, type, converted, enforceHyphenateEnumValue, section, sectionGenerated);
         }
     }

core/processor/src/main/java/io/quarkus/annotation/processor/documentation/config/model/ConfigProperty.java

@@ -27,6 +27,7 @@ public final class ConfigProperty extends AbstractConfigItem {
     private final EnumAcceptedValues enumAcceptedValues;
 
     private final String defaultValue;
+    private final boolean escapeDefaultValue;
 
     private final String javadocSiteLink;
 
@@ -35,7 +36,7 @@ public ConfigProperty(ConfigPhase phase, String sourceType, String sourceElement
             boolean list, boolean optional, boolean secret,
             String mapKey, boolean unnamedMapKey, boolean withinMap, boolean converted, @JsonProperty("enum") boolean isEnum,
             EnumAcceptedValues enumAcceptedValues,
-            String defaultValue, String javadocSiteLink,
+            String defaultValue, boolean escapeDefaultValue, String javadocSiteLink,
             Deprecation deprecation) {
         super(sourceType, sourceElementName, sourceElementType, path, type, deprecation);
         this.phase = phase;
@@ -52,6 +53,7 @@ public ConfigProperty(ConfigPhase phase, String sourceType, String sourceElement
         this.isEnum = isEnum;
         this.enumAcceptedValues = enumAcceptedValues;
         this.defaultValue = defaultValue;
+        this.escapeDefaultValue = escapeDefaultValue;
         this.javadocSiteLink = javadocSiteLink;
     }
 
@@ -121,6 +123,10 @@ public String getDefaultValue() {
         return defaultValue;
     }
 
+    public boolean isEscapeDefaultValue() {
+        return escapeDefaultValue;
+    }
+
     public String getJavadocSiteLink() {
         return javadocSiteLink;
     }

core/processor/src/main/java/io/quarkus/annotation/processor/documentation/config/resolver/ConfigResolver.java

@@ -213,7 +213,7 @@ private void resolveProperty(ConfigRoot configRoot, Map<String, ConfigSection> e
                     discoveryConfigProperty.isUnnamedMapKey(), context.isWithinMap(),
                     discoveryConfigProperty.isConverted(),
                     discoveryConfigProperty.getType().isEnum(),
-                    enumAcceptedValues, defaultValue,
+                    enumAcceptedValues, defaultValue, discoveryConfigProperty.isEscapeDefaultValueForDoc(),
                     JavadocUtil.getJavadocSiteLink(typeBinaryName),
                     deprecation);
             context.getItemCollection().addItem(configProperty);

core/processor/src/main/java/io/quarkus/annotation/processor/documentation/config/scanner/ConfigMappingListener.java

@@ -152,8 +152,12 @@ public void onEnclosedMethod(DiscoveryRootElement discoveryRootElement, TypeElem
 
         AnnotationMirror configDocDefaultAnnotation = methodAnnotations.get(Types.ANNOTATION_CONFIG_DOC_DEFAULT);
         if (configDocDefaultAnnotation != null) {
-            builder.defaultValueForDoc(
-                    configDocDefaultAnnotation.getElementValues().values().iterator().next().getValue().toString());
+            String value = (String) utils.element().getAnnotationValues(configDocDefaultAnnotation).get("value");
+            builder.defaultValueForDoc(value);
+            Boolean escape = (Boolean) utils.element().getAnnotationValues(configDocDefaultAnnotation).get("escape");
+            if (escape != null) {
+                builder.escapeDefaultValueForDoc(escape);
+            }
         }
 
         if (resolvedType.isMap()) {

core/runtime/src/main/java/io/quarkus/runtime/annotations/ConfigDocDefault.java

@@ -22,4 +22,6 @@
 public @interface ConfigDocDefault {
 
     String value();
+
+    boolean escape() default true;
 }

devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/AbstractFormatter.java

@@ -252,7 +252,11 @@ private String formatSingleDefaultValue(ConfigProperty configProperty, String de
             }
         }
 
-        return escapeDefaultValue(defaultValue);
+        if (configProperty.isEscapeDefaultValue()) {
+            return escapeDefaultValue(defaultValue);
+        } else {
+            return defaultValue;
+        }
     }
 
     private static String trimFinalDot(String javadoc) {

extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesConfig.java

@@ -7,6 +7,7 @@
 import java.util.OptionalInt;
 import java.util.Set;
 
+import io.quarkus.runtime.annotations.ConfigDocDefault;
 import io.quarkus.runtime.annotations.ConfigDocMapKey;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.quarkus.runtime.configuration.MemorySize;
@@ -40,6 +41,7 @@ public interface KeycloakDevServicesConfig {
      * ends with `-legacy`.
      * Override with `quarkus.keycloak.devservices.keycloak-x-image`.
      */
+    @ConfigDocDefault(value = "{keycloak-docker-image}", escape = false)
     Optional<String> imageName();
 
     /**