Merge pull request #41909 from edeandrea/distinguish-non-instantiable…

…-builditem-in-doc Distinguish non-instantiable build items
quarkusio · Jul 19, 2024 · f84b683 · f84b683
2 parents 65b9c8d + f9efa74
commit f84b683
Show file tree

Hide file tree

Showing 2 changed files with 8 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:building[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,10 +186,14 @@ private void printTableRow(Pair<Path, JavaClassSource> pair) {
         String className = source.getQualifiedName();
         String attributes = buildAttributes(source);
         String description = getJavaDoc(source);
+        String baseBuildItemText = source.isAbstract()
+                ? "icon:building[title=Non-instantiatable Build Item (can be inherited from)]"
+                : "";
 
         String linkToClass = String.format("%s[`%s`, window=\"_blank\"]", link, className);
 
-        out.println(String.format("\n\na|%s\n[.description]\n--\n%s\n-- a|%s",
+        out.println(String.format("\n\na|%s %s\n[.description]\n--\n%s\n-- a|%s",
+                baseBuildItemText,
                 linkToClass,
                 javadocToAsciidoc(description),
                 attributes));