Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Distinguish non-instantiable build items #41909

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Distinguish non-instantiable build items #41909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/src/main/asciidoc/all-builditems.adoc
View file
Open in desktop
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]
6 changes: 5 additions & 1 deletion docs/src/main/java/io/quarkus/docs/generation/QuarkusBuildItemDoc.java
View file
Open in desktop
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