Full-project, detailed Javadoc generation

Description

Adds a Gradle task that generates Javadoc for the entire project, with nice links and source references.

The stock Gradle tasks generate Javadoc strictly within the module, so (for example) any common class references in the worker are prefixed with the entire package names and links are missing. Having to keep track of three tabs of different Javadoc sites is not nice, so unification is important if we want developer-friendly documentation. And one of the important lessons of this year is that such documentation is very scarce.

Additions

• A new Gradle task fullJavadoc that generates Javadoc for the entire project

Test and Review

To be filled in by the reviewers

• There are no unnecessary files present in the MR

• The continuous integration has no problems with the MR

• The MR is filled in as requested (including labels, milestones, and reviewers)

• The documentation is up-to-date

changed milestone to %20-time

added 1 deleted label

Should I still spend time creating the separate api documentation if we are going to use the javadoc to create the documentation as was suggested by Annibale? And if I recall correctly, Tim was going to create that javadoc alongside the clean up of all the endpoints after the presentation.

Not really related here, as this is for the Java API. I'll forward your question to the group on Discord ;-)

approved this merge request

approved this merge request

merged

mentioned in commit 1258ebb3

unassigned @leverse