Javadoc documentation for Petascope

[Piero Campalani]

This ticket is a call for a general fix of the incomplete Javadoc documentation of Petascope.

Purpose: aaving a rich and complete Javadoc for both HTML API doc, and possible automatically generated graphical documentation, e.g. UML diagrams from javadoc via ​UMLGraph.

[Dimitar Misev]

First step is to fix the warnings that appear when building the javadoc. To generate the javadoc:

cd applications/petascope
make javadoc

Warnings like these should be fixed:

src/main/java/petascope/wcs2/handlers/AbstractRequestHandler.java:38: warning - Tag @link: reference not found: WcsOperation
src/main/java/petascope/wcs2/parsers/AbstractRequestParser.java:31: warning - Tag @link: reference not found: WcsOperationBinding
src/main/java/petascope/wcs2/handlers/RequestHandler.java:33: warning - Tag @link: reference not found: Request

[Dimitar Misev]

Let me reiterate: first fix only the warning.

Then ticket ownership will go back to me and Piero — for high-level package documentation, and a little bit for the most important classes where missing.

Afterwards we should close the ticket. Forget about going systematically over the whole code/methods/variables and documenting everything, that is not feasible.

[Piero Campalani]

Warnings fixed in changeset:9521f18 (uadhikari).

[Dimitar Misev]

Closing this ticket as too broad.