Add tooltip inline macro in order to display extra info in config table #1406
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enum constant documentation is not propagated to Quarkus website. One example-
io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification
has clear documentation of whatREQUIRED
,CERTIFICATE_VALIDATION
andNONE
means, however you won't find that in documentation. The meaning of this constants was enigma for me till I checked the codes, but if we want developers to do that, there is no point of providing Quarkus website at the first place.My idea is that we use tooltip to show description. In
io.quarkus.annotation.processor.generate_doc.ConfigDoItemFinder#extractEnumValues
if there is constant description, we append value like thistooltip:REQUIRED[+++Certificates are validated and hostname verification is enabled. This is the default value.+++]
and we alterio.quarkus.annotation.processor.generate_doc.SummaryTableDocFormatter#TABLE_ROW_FORMAT
to prefix respective cell delimiter witha
.I am happy to implement the other part (in quarkus annotation processor), but it does not make sense till we have a way to display description.