Project

General

Profile

Actions

bug #6241

open

fix java doc problems in projects

Added by Andreas Kohlbecker about 6 years ago. Updated almost 3 years ago.

Status:
Feedback
Priority:
Highest
Category:
cdmlib
Start date:
Due date:
% Done:

40%

Estimated time:
Severity:
normal
Found in Version:
Tags:

Description

javadoc problems exist in the following projects and should be fixed (see also #6240 this is not a duplicate!). The reference on all existing javadoc tags: http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#javadoctags

IMPORTANT

In order to properly test for existing problems you may need to diable the fix applied in cdmlib|99f6d80

Projects with problems:

  • cdmlib TODO
  • cdm-vaadin TODO (#8864)
  • cdm-server TODO (#8864)
  • cdm-dataportal TODO (#8864)

List of problems:

  • @date tag is not officially supported --> remove or replace?
  • broken @link references (151x in cdmlib) these should be fixed. Do not delete them!

Related issues

Copied from EDIT - bug #6240: maven javadoc plugin fails with java 1.8ClosedPatrick Plitzner

Actions
Copied to EDIT - bug #8864: fix java doc problems in projects in vaadin, cdmserver and dataportalNewAndreas Kohlbecker

Actions
Actions #1

Updated by Andreas Kohlbecker about 6 years ago

  • Category set to cdmlib
Actions #2

Updated by Andreas Kohlbecker about 6 years ago

  • Related to bug #6240: maven javadoc plugin fails with java 1.8 added
Actions #3

Updated by Andreas Kohlbecker about 6 years ago

  • Tags set to jdk1.8
Actions #4

Updated by Andreas Kohlbecker about 6 years ago

  • Description updated (diff)
Actions #5

Updated by Andreas Kohlbecker about 6 years ago

  • Description updated (diff)
Actions #6

Updated by Andreas Müller almost 6 years ago

A solution might be to replace all "* @date " by "* @since "

Actions #7

Updated by Andreas Müller almost 6 years ago

  • Assignee set to Andreas Kohlbecker
Actions #8

Updated by Andreas Kohlbecker almost 6 years ago

Andreas Müller wrote:

A solution might be to replace all "* @date " by "* @since "

The doc says the since text is free, so we could use it for the creation date, but usually one would rather expect a version number for since.

Actions #9

Updated by Andreas Müller almost 6 years ago

Andreas Kohlbecker wrote:

Andreas Müller wrote:

A solution might be to replace all "* @date " by "* @since "

The doc says the since text is free, so we could use it for the creation date, but usually one would rather expect a version number for since.

That is true. But maybe we should start handling it this way. Version numbers are more useful than dates. However, the question is how we get eclipse to know the current version number and how if we want to update the existing tags.
I think we can live with existing tags being changed to @since with the given date.
For new tags it would be nice to have version number instead of date if possible.

Actions #10

Updated by Andreas Müller almost 6 years ago

  • Assignee changed from Andreas Kohlbecker to Patrick Plitzner
  • Priority changed from New to Highest
  • Target version changed from Unassigned CDM tickets to Release 4.6
Actions #11

Updated by Patrick Plitzner almost 6 years ago

  • Related to deleted (bug #6240: maven javadoc plugin fails with java 1.8)
Actions #12

Updated by Patrick Plitzner almost 6 years ago

  • Is duplicate of bug #6240: maven javadoc plugin fails with java 1.8 added
Actions #13

Updated by Andreas Müller over 5 years ago

  • Target version changed from Release 4.6 to Release 4.7
Actions #14

Updated by Andreas Kohlbecker over 5 years ago

  • Is duplicate of deleted (bug #6240: maven javadoc plugin fails with java 1.8)
Actions #15

Updated by Andreas Kohlbecker over 5 years ago

  • Related to bug #6240: maven javadoc plugin fails with java 1.8 added
Actions #16

Updated by Andreas Kohlbecker over 5 years ago

  • Description updated (diff)
Actions #17

Updated by Andreas Kohlbecker over 5 years ago

  • Description updated (diff)
Actions #18

Updated by Andreas Kohlbecker over 5 years ago

  • Description updated (diff)
Actions #19

Updated by Andreas Müller over 5 years ago

AK: Ich habe auch nachgezählt bei den '@link reference not found' Problemen handelt es sich um 151 stellen die sich aber auf relativ wenige HotSpots konzentrieren, vom Aufwand halte ich das für absolut vertretbar.

Actions #20

Updated by Andreas Müller over 5 years ago

  • Target version changed from Release 4.7 to Release 4.8
Actions #21

Updated by Andreas Müller over 5 years ago

  • Target version changed from Release 4.8 to Release 4.9
Actions #22

Updated by Andreas Müller over 5 years ago

  • Target version changed from Release 4.9 to Release 4.10
Actions #23

Updated by Patrick Plitzner over 5 years ago

  • Related to deleted (bug #6240: maven javadoc plugin fails with java 1.8)
Actions #24

Updated by Patrick Plitzner over 5 years ago

  • Copied from bug #6240: maven javadoc plugin fails with java 1.8 added
Actions #25

Updated by Andreas Müller about 5 years ago

  • Target version changed from Release 4.10 to Release 4.11
Actions #26

Updated by Andreas Müller about 5 years ago

  • Target version changed from Release 4.11 to Release 4.12
Actions #27

Updated by Andreas Kohlbecker about 5 years ago

  • Description updated (diff)
Actions #28

Updated by Andreas Müller about 5 years ago

  • Target version changed from Release 4.12 to Release 4.13
Actions #29

Updated by Andreas Müller almost 5 years ago

  • Target version changed from Release 4.13 to Release 4.14
Actions #30

Updated by Andreas Müller almost 5 years ago

  • Target version changed from Release 4.14 to Release 5.0
Actions #31

Updated by Andreas Müller over 4 years ago

  • Description updated (diff)
  • % Done changed from 0 to 30

replaced @date by @since

Actions #32

Updated by Andreas Müller over 4 years ago

  • % Done changed from 30 to 40
Actions #33

Updated by Patrick Plitzner over 4 years ago

  • Target version changed from Release 5.0 to Release 5.1
Actions #34

Updated by Patrick Plitzner over 4 years ago

  • Status changed from New to Feedback
  • Assignee changed from Patrick Plitzner to Andreas Müller

We should discuss if it is really necessary to fix the broken links. I also took a quick look and it seems that in most cases there is one broken link in one class file. I think this is too much work for a non critical issue

Actions #35

Updated by Andreas Müller over 4 years ago

  • Assignee changed from Andreas Müller to Andreas Kohlbecker

Andreas K., do you have an opinion on this?

Actions #36

Updated by Andreas Kohlbecker over 4 years ago

There are far less problems as you've assumed after having a quick look. mvn javadoc:javadoc reports 294 broken @links for which reference classes or methods. This does not include test classes.

Maven provides a tool to interactively fix problems in javadoc tags (https://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html) which is supposed to also fix @link tags.

mvn javadoc:fix

I did a test run of this tool. I did not fix the broken @links but it does a lot of other useful things. I think we should run this on our projects with selected parameters.

Actions #37

Updated by Andreas Kohlbecker over 4 years ago

  • Assignee changed from Andreas Kohlbecker to Andreas Müller
Actions #38

Updated by Andreas Müller over 4 years ago

  • Target version changed from Release 5.1 to Release 5.2
Actions #39

Updated by Andreas Müller over 4 years ago

  • Target version changed from Release 5.2 to Release 5.3
Actions #40

Updated by Andreas Müller about 4 years ago

  • Target version changed from Release 5.3 to Release 5.5
Actions #41

Updated by Andreas Müller almost 4 years ago

  • Target version changed from Release 5.5 to Release 5.7
Actions #42

Updated by Andreas Müller over 3 years ago

  • Target version changed from Release 5.7 to Release 5.10
Actions #43

Updated by Andreas Müller about 3 years ago

  • Target version changed from Release 5.10 to Release 5.11
Actions #44

Updated by Andreas Müller about 3 years ago

  • Target version changed from Release 5.11 to Release 5.13
Actions #45

Updated by Andreas Müller almost 3 years ago

  • Description updated (diff)
Actions #46

Updated by Andreas Müller almost 3 years ago

  • Target version changed from Release 5.13 to Reviewed Next Major Release
Actions #47

Updated by Andreas Müller almost 3 years ago

  • Copied to bug #8864: fix java doc problems in projects in vaadin, cdmserver and dataportal added
Actions #48

Updated by Andreas Müller almost 3 years ago

  • Description updated (diff)

we split this ticket to split workload => #8864

Actions #49

Updated by Andreas Müller almost 3 years ago

  • Description updated (diff)
Actions #50

Updated by Andreas Müller almost 3 years ago

  • Description updated (diff)
Actions

Also available in: Atom PDF