Show Enum constant description in documentation

[michalvavrik]

Currently Enum constant Javadoc is not included in generated documentation. This PR adds a constant description to the documentation in a form of a CSS Tooltip (Tooltip was added by this PR). PDF generation won't be affected by this PR.

[machi1990]

Thanks for adding this @michalvavrik

I'll have a look at it properly tomorrow. Is it possible to share an example generated output?

[michalvavrik]

@machi1990 I'd suggest to generate docs (mvn clean install -DskipTests -DskipITs -Denforcer.skip -DskipExtensionValidation -Dinvoker.skip -Dforbiddenapis.skip -DskipCodestartValidation) and look for tooltip: (grep -l 'tooltip:' target/ -R). You should find plenty of examples in quarkus-all-config.adoc. You can also see the result if you copy this file to generated-config/latest/config/quarkus-all-config.adoc prior to running bundle exec jekyll serve in quarkusio.github.io. This should give you bigger advantage than if I provided generated output. If I can help you in anyway, don't hesitate to contact me.

[machi1990]

@machi1990 I'd suggest to generate docs (mvn clean install -DskipTests -DskipITs -Denforcer.skip -DskipExtensionValidation -Dinvoker.skip -Dforbiddenapis.skip -DskipCodestartValidation) and look for tooltip: (grep -l 'tooltip:' target/ -R). You should find plenty of examples in quarkus-all-config.adoc.

Thanks, I know this ;-)

You can also see the result if you copy this file to generated-config/latest/config/quarkus-all-config.adoc prior to running bundle exec jekyll serve in quarkusio.github.io. This should give you bigger advantage than if I provided generated output. If I can help you in anyway, don't hesitate to contact me.

I was asking more of a generated live output from this step which you seem to have already done end to end. So if you still have it, it'll be good to see it along side the PR description for better visualization.

/cc @gsmet you might also be interested in this PR

[machi1990]

lgtm

I can see the tooltip being generated in the .ascidoc generated output.

However, I could not verify the whole rendering as I do not have the full toolset. @gsmet would you be able to verify this part and how it'll render on the website?

[michalvavrik]

generated-live-output.zip
I see, let's try unzip this file and open Quarkus - All configuration options.html (the rest of files are required in order to display page correctly).

[machi1990]

generated-live-output.zip I see, let's try unzip this file and open Quarkus - All configuration options.html (the rest of files are required in order to display page correctly).

Thanks @michalvavrik, fantastic work. The tooltip renders nicely.