quarkusio / quarkus

Quarkus: Supersonic Subatomic Java.
https://quarkus.io
Apache License 2.0
13.73k stars 2.67k forks source link

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

Open holly-cummins opened 11 months ago

holly-cummins commented 11 months ago

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 https://github.com/quarkusio/quarkus/commit/9713f7fc044e3d5a1a47ea69c171743a6945af64 (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
 * {@code ReflectiveClassBuildItem}

is not displayed

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

image image image image

Missing javadoc

quarkus-bot[bot] commented 11 months ago

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