-
Notifications
You must be signed in to change notification settings - Fork 13
Javadoc validation
This is an attempt to document the process I'm not familiar with : so please fix if anything here is wrong or incomplete!
Javadoc errors are logged under "Javadoc Logs" page on each platform build, like in 4.27.
If the javadoc error files are not empty, org.eclipse.releng.tests.BuildTests.testJavadocLogs will report a fail.
How the build is triggered and where to find tasks output which produce error files like jdt.doc.isv.javadoc.txt
Javadoc generation uses a independent javadoc executable and runs as a separate process. One need to add all the required dependencies in the classpath used by javadoc executable. This done in the Options.txt files inside documentation bundles projects. The projects are under https://github.com/eclipse-platform/eclipse.platform.common/tree/master/bundles
Example https://github.com/eclipse-platform/eclipse.platform.common/pull/19/files
See also https://wiki.eclipse.org/How_to_add_things_to_the_Eclipse_doc
Source code for javadoc bundles is located at https://github.com/eclipse-platform/eclipse.platform.common.
javadoc is generated using ant script buildDoc.xml located in each of the java doc plugin source. we use eclipse antrunner to run this script.
The specific location where we actually generate is https://github.com/eclipse-platform/eclipse.platform.common/blob/54455a117960237d69a9d840e61872641cafdaaa/bundles/org.eclipse.jdt.doc.isv/buildDoc.xml#L141. The javadoc executable will generate a doc.bin.log file with all the errors javadoc executable found. This gets renamed appropriately with this line https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/blob/1bbda0a96dc04e93bdc1bb91813a5d98b5659653/cje-production/mbscripts/mb300_gatherEclipseParts.sh#L247