La 23.07.2020 11:56, David Leangen a scris:
For Mailet/Matchers, I would port existing documentation from javadoc to antora
(and use includes to not duplicate the sources).
Do you mean transform from Javadoc format to asciidoc format (either manually
or with a conversation tool)?
Or do you mean build a tool to extract the Javadoc and transform it to asciidoc?
JavaDoc would be more for targeting "developers" and is a nice to have too.
Especially for API projects (mailet-api, mailbox-api, mailqueue-api, etc...) where
Javadoc is both maintained and valuable.
If somebody can integrate the javadoc into the build (if it isn’t already),
then I can look into integrating the javadocs into Antora.
Gradle and maven both generate javadoc jars = jar files that contain
HTML pages.
We don't need to convert anything to AsciiDoc - we need to publish the
HTML files so people have the documentation online.
Gradle can download, pack / unpack all of the javadoc jars and push them
as html pages to be available online.
We can add a link in AsciiDoc pages to the place where we will push the
javadoc html files.
The only issue I see is that we have a gazillion modules in James, each
production jars and javadocs.
IMO that is an issue that we will need to address as part of the
https://issues.apache.org/jira/browse/JAMES-3259 .
--
Eugen Stan
+40720 898 747 / netdava.com
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
