Skip to content

Commit

Permalink
Merge pull request quarkusio#41909 from edeandrea/distinguish-non-ins…
Browse files Browse the repository at this point in the history
…tantiable-builditem-in-doc

Distinguish non-instantiable build items
  • Loading branch information
gastaldi authored Jul 19, 2024
2 parents 65b9c8d + f9efa74 commit f84b683
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/src/main/asciidoc/all-builditems.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down

0 comments on commit f84b683

Please sign in to comment.