Project

General

Profile

Bug #5834

Fix Kepler Javadoc warnings

Added by Christopher Brooks over 6 years ago. Updated over 6 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
documentation
Target version:
Start date:
01/30/2013
Due date:
% Done:

0%

Estimated time:
Spent time:
Bugzilla-Id:
5834

Description

Running "ant javadoc" produces warnings about javadoc problems.
The Kepler nightly build at Berkeley now reports these warnings, see
http://sisyphus:8079/hudson/job/kepler/warnings31

It would be good to fix these warnings.

History

#1 Updated by Redmine Admin over 6 years ago

Original Bugzilla ID was 5834

#2 Updated by Christopher Brooks over 6 years ago

  • Assignee deleted (Ilkay Altintas)

Java 1.7.0_17 has a bug that prevents 'ant javadoc' from completing. The problem is that between Java 1.7.0_15 and 1.7.0_17, there was a regression where javadoc in _17 tries to parse the .class files. The errors look like:

create-javadoc] /home/hudson/jobs/kepler/workspace/r/target/classes/org/ecoinformatics/seek/R/RExpression.class:463: error: unmappable character for encoding UTF8
[create-javadoc] ^C�^Q^O^C�^Q=^C�^Q@^C�^QB^C�^QO^C�^QY^C�^Qb^C�^Qk^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^Q�^C�^R^F^C�^R

The problem is that the resulting log file tends to be huge, on the order of >500 gig. The issue is that JDK1.7.0_15 has security problems and running javadoc under 1.7.0_15 results in the javadoc process going out over the network which triggers security tools that look for JDK 1.7.0_15 accesses on the network.

I tried using JDK 8 and while this bug is fixed, javadoc in JDK 8 marks many of what used to be warnings as errors.

For example:

[create-javadoc] /home/hudson/jobs/kepler/workspace/gui/src/org/kepler/gui/BasicLibraryPane.java:67: error: @param name not found
[create-javadoc] * @param _libraryModel

This means that when 'ant javadoc' completes, it returns 1, and ant indicates that there is an error:

[create-javadoc] 100 errors
[create-javadoc] 100 warnings
[create-javadoc] IOException: java.io.IOException: Subprocess "javadoc -d /home/hudson/jobs/kepler/workspace/javadoc -sourcepath [path removed by cxh] -tagletpath /home/hudson/jobs/kepler/workspace/ptolemy/target/classes -exclude **.test:org.ptolemy.fmi:org.ptolemy.ptango:ptdb:ptolemy.actor.lib.database:ptolemy.actor.lib.embeddedJava:ptolemy.actor.lib.excel:ptolemy.actor.lib.fmi:ptolemy.actor.lib.io.comm:ptolemy.actor.lib.jai:ptolemy.actor.lib.jmf:ptolemy.actor.lib.jni:ptolemy.actor.lib.jopio:ptolemy.actor.lib.joystick:ptolemy.actor.lib.jxta:ptolemy.actor.lib.logic.fuzzy:ptolemy.actor.lib.mail:ptolemy.actor.lib.net:ptolemy.actor.lib.opencv:ptolemy.actor.lib.openmodelica:ptolemy.actor.lib.reactable:ptolemy.actor.lib.security:ptolemy.actor.lib.vhdl:ptolemy.actor.lib.video:ptolemy.actor.lib.x10:ptolemy.actor.ptalon:ptolemy.apps:ptolemy.backtrack:ptolemy.backtrack.eclipse:ptolemy.backtrack.test:ptolemy.caltrop:ptolemy.cg:ptolemy.codegen:ptolemy.copernicus:ptolemy.data.ontologies:ptolemy.distributed:ptolemy.domains.ca:ptolemy.domains.ci:ptolemy.domains.coroutine:ptolemy.domains.csp:ptolemy.domains.curriculum:ptolemy.domains.dde:ptolemy.domains.fsm.kernel.fmv:ptolemy.domains.giotto:ptolemy.domains.gr:ptolemy.domains.gro:ptolemy.domains.hdf:ptolemy.domains.jogl:ptolemy.domains.modal.kernel.fmv:ptolemy.domains.metroII:ptolemy.domains.ontologies:ptolemy.domains.openmodelica:ptolemy.domains.petrinet:ptolemy.domains.psdf:ptolemy.domains.pthales:ptolemy.domains.ptides:ptolemy.domains.ptinyos:ptolemy.domains.rendezvous:ptolemy.domains.sequence:ptolemy.domains.space:ptolemy.domains.sr:ptolemy.domains.taskpt:ptolemy.domains.tdl:ptolemy.domains.tester:ptolemy.domains.tm:ptolemy.domains.wireless:ptolemy.homer:ptolemy.moml.jxta:ptolemy.plot.servlet:ptolemy.vergil.basic.export.itextpdf:ptolemy.vergil.basic.imprt.fmu:ptolemy.vergil.fsm.fmv:ptolemy.vergil.modal.fmv:ptolemy.vergil.ontologies:ptolemy.vergil.tdl:ptolemy.verification:ptserver -subpackages org:com:util:ptolemy -link http://download.oracle.com/javase/6/docs/api/ -linksource -author -breakiterator -use -quiet -tag Pt.AcceptedRating -tag Pt.ProposedRating -tag category.name -tag UserLevelDocumentation -tag created -tag entity.description -tag status -taglet doc.doclets.RatingTaglet -J-Xmx1024m" returned 1
[create-javadoc] All Done

Oddly, Hudson reports the javadoc errors as javac warnings.

Also available in: Atom PDF