[TOMEE-2347] Use Asciidoc for all Javadoc

• Type: Wish
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Examples and Documentation
• Assignee: Unassigned
• Reporter: David Blevins
• Created: 09/Dec/18 19:03
• Updated: 10/Oct/22 14:06

Description

here's a fun idea, write our javadoc in asciidoc format

• https://asciidoctor.org/news/2013/06/03/asciidoclet-announcement/

Where there is javadoc, it usually is not in the required html format, so this would actually bring us closer in line with what we have done in practice.

 

Other fun bonus, if the majority of our javadoc was in asciidoc, we could potentially improve the site generator to not just pull README.md and README.adoc files as it currently does, but it could potentially pull chunks of asciidoc straight from the source code and use it to fill out some of the online docs.  This would be done separately in TOMEE-2341

Sub-Tasks

• Setup Asciidoclet in root TomEE pom.xml: Resolved
• Ensure each module can generate javadoc jars on release: Open
• Create a list of existing Javadoc using html: Open