Config Doc - Use enum tooltip also for default value

This is an improvement over what we had. Fixes quarkusio#42374
danielsoro · Sep 20, 2024 · bb0f040 · bb0f040
1 parent a22271a
commit bb0f040
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/.../config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/AsciidocFormatter.java b/.../config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/AsciidocFormatter.java
@@ -78,6 +78,10 @@ String formatTypeDescription(ConfigProperty configProperty) {
     String formatDefaultValue(ConfigProperty configProperty) {
         String defaultValue = configProperty.getDefaultValue();
 
+        if (defaultValue == null) {
+            return null;
+        }
+
         if (configProperty.isEnum()) {
             Optional<String> enumConstant = configProperty.getEnumAcceptedValues().values().entrySet().stream()
                     .filter(e -> e.getValue().configValue().equals(defaultValue))

diff --git a/...nfig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java b/...nfig-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/GenerateAsciidocMojo.java
@@ -448,6 +448,12 @@ private static Engine initializeQuteEngine(AsciidocFormatter asciidocFormatter)
                         .applyToNoParameters()
                         .resolveSync(ctx -> asciidocFormatter.formatDescription((ConfigProperty) ctx.getBase()))
                         .build())
+                .addValueResolver(ValueResolver.builder()
+                        .applyToBaseClass(ConfigProperty.class)
+                        .applyToName("formatDefaultValue")
+                        .applyToNoParameters()
+                        .resolveSync(ctx -> asciidocFormatter.formatDefaultValue((ConfigProperty) ctx.getBase()))
+                        .build())
                 .addValueResolver(ValueResolver.builder()
                         .applyToBaseClass(ConfigSection.class)
                         .applyToName("formatTitle")

diff --git a/...fig-doc-maven-plugin/src/main/resources/templates/tags/configProperty.qute.adoc b/...fig-doc-maven-plugin/src/main/resources/templates/tags/configProperty.qute.adoc
@@ -10,4 +10,4 @@ a|{#if configProperty.phase.fixedAtBuildTime}icon:lock[title=Fixed at build time
 {#envVar configProperty /}
 --
 {#if configProperty.enum}a{/if}|{configProperty.formatTypeDescription.escapeCellContent.or("")}
-|{#if configProperty.defaultValue}`{configProperty.defaultValue.escapeCellContent}`{#else if !configProperty.optional}required icon:exclamation-circle[title=Configuration property is required]{/if}
+|{#if configProperty.defaultValue}{configProperty.formatDefaultValue.escapeCellContent}{#else if !configProperty.optional}required icon:exclamation-circle[title=Configuration property is required]{/if}