feat(autodoc): use description annotation field and value as fallback

eclipse-edc · Jan 17, 2025 · dad42ba · dad42ba
1 parent 4bdefc0
commit dad42ba
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/...a/org/eclipse/edc/plugins/autodoc/core/processor/introspection/ExtensionIntrospector.java b/...a/org/eclipse/edc/plugins/autodoc/core/processor/introspection/ExtensionIntrospector.java
@@ -151,9 +151,14 @@ private ConfigurationSetting createConfigurationSetting(VariableElement settingE
                 .orElseGet(() -> attributeValue(String.class, "key", settingMirror, elementUtils))
                 .toString();
 
+        var description = Stream.of(
+                attributeValue(String.class, "description", settingMirror, elementUtils),
+                attributeValue(String.class, "value", settingMirror, elementUtils)
+        ).filter(Objects::nonNull).filter(it -> !it.isEmpty()).findFirst().orElse(null);
+
         return ConfigurationSetting.Builder.newInstance()
                 .key(keyValue)
-                .description(attributeValue(String.class, "value", settingMirror, elementUtils))
+                .description(description)
                 .type(attributeValue(String.class, "type", settingMirror, elementUtils))
                 .required(attributeValue(Boolean.class, "required", settingMirror, elementUtils))
                 .maximum(attributeValue(Long.class, "max", settingMirror, elementUtils))