Distinguish non-instantiable build items

In the all-builditems docs, use an icon/hover to distinguish non-instantiable build items. These can be extended by other build items, so documenting them is good.
edeandrea · Jul 15, 2024 · 4d22b17 · 4d22b17
1 parent d7b84f6
commit 4d22b17
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/src/main/asciidoc/all-builditems.adoc b/docs/src/main/asciidoc/all-builditems.adoc
@@ -11,6 +11,8 @@ include::_attributes.adoc[]
 :categories: writing-extensions
 :summary: Explore all the BuildItems you can consume/produce in your extensions.
 
-Here you can find a list of Build Items and the extension that provides them:
+Here you can find a list of Build Items and the extension that provides them.
+
+icon:lock[title=Non-instantiatable Build Item] Build item can't be instantiated directly, but can be extended/inherited from
 
 include::{generated-dir}/config/quarkus-all-build-items.adoc[opts=optional]
diff --git a/docs/src/main/java/io/quarkus/docs/generation/QuarkusBuildItemDoc.java b/docs/src/main/java/io/quarkus/docs/generation/QuarkusBuildItemDoc.java
@@ -186,8 +186,11 @@ private void printTableRow(Pair<Path, JavaClassSource> pair) {
         String className = source.getQualifiedName();
         String attributes = buildAttributes(source);
         String description = getJavaDoc(source);
+        String baseBuildItemText = source.isAbstract()
+                ? "icon:lock[title=Non-instantiatable Build Item (can be inherited from)]"
+                : "";
 
-        out.println("a| " + link + "[`" + className + "`, window=\"_blank\"] :: +++" +
+        out.println("a|" + baseBuildItemText + " " + link + "[`" + className + "`, window=\"_blank\"] :: +++" +
                 javadocToHTML(description) + "+++");
         out.println("a| " + attributes);
     }