Opened 4 years ago

Closed 21 months ago

#488 closed defect (invalid)

Javadoc documentation for Petascope

Reported by: pcampalani Owned by: gxinghua
Priority: major Milestone: Future
Component: petascope Version: 8.5
Keywords: javadoc Cc:
Complexity: Easy

Description

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.

Change History (6)

comment:1 Changed 3 years ago by dmisev

  • Owner changed from pcampalani to uadhikari
  • Status changed from new to assigned

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

comment:2 Changed 3 years ago by dmisev

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.

comment:3 Changed 3 years ago by pcampalani

Warnings fixed in changeset:9521f18 (uadhikari).

comment:4 Changed 3 years ago by pcampalani

  • Owner changed from uadhikari to pcampalani

comment:5 Changed 3 years ago by gxinghua

  • Owner changed from pcampalani to gxinghua

comment:6 Changed 21 months ago by dmisev

  • Resolution set to invalid
  • Status changed from assigned to closed

Closing this ticket as too broad.

Note: See TracTickets for help on using tickets.