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.

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

Broken and missing Javadoc for some build items on https://quarkus.io/guides/all-builditems #37290

Open
holly-cummins opened this issue Nov 23, 2023 · 1 comment
Labels
area/documentation kind/bug Something isn't working

Comments

@holly-cummins
Copy link
Contributor

holly-cummins commented Nov 23, 2023

Describe the bug

Since the build item javadoc is effectively our SPI to extension authors, and since it's all published at https://quarkus.io/guides/all-builditems, we want it to be complete and informative, and not have weird formatting defects where content stops in the middle of a sentence because links aren't displayed.

We had a big improvement to our javadoc @nderwin in 9713f7f (yay!). However, I think Nathan focused more on improving the wording of what we already had, rather than filling in blanks or correcting a formatting big. Nathan's improvements are not reflected on the live site yet, but hopefully I didn't duplicate things he's fixed.

Broken javadoc

Often, for these, the source code looks ok, but something is messing up the formatting, usually where we use a link in the javadoc.

image image
 * {@code ReflectiveClassBuildItem}

is not displayed

-io.quarkus.deployment.builditem.nativeimage.NativeImageAllowIncompleteClasspathAggregateBuildItem

image image image image image

Missing javadoc

Copy link

quarkus-bot bot commented Nov 24, 2023

/cc @MichalMaler (documentation), @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @rolfedh (documentation), @sheilamjones (documentation), @sunayna15 (documentation)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/bug Something isn't working
Projects
Development

No branches or pull requests

2 participants