Project

General

Profile

bug #6241

fix java doc problems in projects

Added by Andreas Kohlbecker over 2 years ago. Updated 23 days ago.

Status:
Feedback
Priority:
Highest
Category:
cdmlib
Target version:
Start date:
12/05/2016
Due date:
% Done:

40%

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
  • cdm-servver TODO
  • cdm-dataportal TODO

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.8 Closed 12/05/2016

Associated revisions

Revision 31adf9f4 (diff)
Added by Andreas Kohlbecker over 2 years ago

fix #6240 disabling doclint in javadoc for jdk.8

Revision b139097d (diff)
Added by Andreas Kohlbecker over 2 years ago

fix #6240 disabling doclint in javadoc for jdk.8

Revision 99f6d804 (diff)
Added by Andreas Kohlbecker about 2 years ago

#6241 disabling doclint in javadoc-plugin

Revision d2fbb2f5 (diff)
Added by Andreas Kohlbecker about 2 years ago

ref #6240 ref #6241 disabling doclint in javadoc for jdk.8

Revision e37e4d0c (diff)
Added by Andreas Kohlbecker over 1 year ago

ref #6241 disabling doclint in javadoc for jdk.8 and fixing a couple of java doc problems

Revision 43e5a7b1 (diff)
Added by Andreas Kohlbecker over 1 year ago

ref #6241 disabling doclint in javadoc for jdk.8 and fixing a couple of java doc problems

Revision 59d195ef (diff)
Added by Andreas Kohlbecker over 1 year ago

ref #6241 disabling doclint in javadoc for jdk.8 and fixing a couple of java doc problems

Revision 7fa325bc (diff)
Added by Andreas Müller about 1 year ago

ref #6241 change @date to @since

Revision 53db84af (diff)
Added by Andreas Müller about 1 year ago

ref #6241 change @date to @since (fix)

Revision 53d7c437 (diff)
Added by Andreas Müller about 1 year ago

ref #6241 change @date to @since in appimport

Revision a88578ce (diff)
Added by Andreas Müller about 1 year ago

ref #6241 replaced @created by @since in cdmlib

Revision a13538c8 (diff)
Added by Andreas Müller about 1 year ago

ref #6241 replaced @created by @since in cdmlib-app

Revision 539794c5 (diff)
Added by Andreas Müller about 1 year ago

ref #6241 replaced @date by @since in vaadin

Revision 8e9419c3 (diff)
Added by Andreas Müller about 1 year ago

ref #6241 replaced @date by @since in pesi and eflora

History

#1 Updated by Andreas Kohlbecker over 2 years ago

  • Category set to cdmlib

#2 Updated by Andreas Kohlbecker over 2 years ago

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

#3 Updated by Andreas Kohlbecker over 2 years ago

  • Tags set to jdk1.8

#4 Updated by Andreas Kohlbecker over 2 years ago

  • Description updated (diff)

#5 Updated by Andreas Kohlbecker over 2 years ago

  • Description updated (diff)

#6 Updated by Andreas Müller over 2 years ago

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

#7 Updated by Andreas Müller over 2 years ago

  • Assignee set to Andreas Kohlbecker

#8 Updated by Andreas Kohlbecker over 2 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.

#9 Updated by Andreas Müller over 2 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.

#10 Updated by Andreas Müller over 2 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

#11 Updated by Patrick Plitzner over 2 years ago

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

#12 Updated by Patrick Plitzner over 2 years ago

  • Duplicates bug #6240: maven javadoc plugin fails with java 1.8 added

#13 Updated by Andreas Müller about 2 years ago

  • Target version changed from Release 4.6 to Release 4.7

#14 Updated by Andreas Kohlbecker about 2 years ago

  • Duplicates deleted (bug #6240: maven javadoc plugin fails with java 1.8)

#15 Updated by Andreas Kohlbecker about 2 years ago

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

#16 Updated by Andreas Kohlbecker about 2 years ago

  • Description updated (diff)

#17 Updated by Andreas Kohlbecker about 2 years ago

  • Description updated (diff)

#18 Updated by Andreas Kohlbecker about 2 years ago

  • Description updated (diff)

#19 Updated by Andreas Müller about 2 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.

#20 Updated by Andreas Müller about 2 years ago

  • Target version changed from Release 4.7 to Release 4.8

#21 Updated by Andreas Müller almost 2 years ago

  • Target version changed from Release 4.8 to Release 4.9

#22 Updated by Andreas Müller almost 2 years ago

  • Target version changed from Release 4.9 to Release 4.10

#23 Updated by Patrick Plitzner almost 2 years ago

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

#24 Updated by Patrick Plitzner almost 2 years ago

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

#25 Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 4.10 to Release 4.11

#26 Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 4.11 to Release 4.12

#27 Updated by Andreas Kohlbecker over 1 year ago

  • Description updated (diff)

#28 Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 4.12 to Release 4.13

#29 Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 4.13 to Release 4.14

#30 Updated by Andreas Müller over 1 year ago

  • Target version changed from Release 4.14 to Release 5.0

#31 Updated by Andreas Müller about 1 year ago

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

replaced @date by @since

#32 Updated by Andreas Müller about 1 year ago

  • % Done changed from 30 to 40

#33 Updated by Patrick Plitzner about 1 year ago

  • Target version changed from Release 5.0 to Release 5.1

#34 Updated by Patrick Plitzner about 1 year 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

#35 Updated by Andreas Müller 12 months ago

  • Assignee changed from Andreas Müller to Andreas Kohlbecker

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

#36 Updated by Andreas Kohlbecker 11 months 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.

#37 Updated by Andreas Kohlbecker 11 months ago

  • Assignee changed from Andreas Kohlbecker to Andreas Müller

#38 Updated by Andreas Müller 11 months ago

  • Target version changed from Release 5.1 to Release 5.2

#39 Updated by Andreas Müller 9 months ago

  • Target version changed from Release 5.2 to Release 5.3

#40 Updated by Andreas Müller 9 months ago

  • Target version changed from Release 5.3 to Release 5.5

#41 Updated by Andreas Müller 4 months ago

  • Target version changed from Release 5.5 to Release 5.7

#42 Updated by Andreas Müller 23 days ago

  • Target version changed from Release 5.7 to Release 5.9

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 40 MB)