Bug #2327

rsb-java maven job fails due to javadoc issues

Added by A. Neumann over 6 years ago. Updated over 6 years ago.

Status:ResolvedStart date:06/25/2015
Priority:NormalDue date:
Assignee:-% Done:

100%

Category:Java
Target version:rsb-0.13

Description

Newly generated jenkins jobs fail with

Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.3:jar (default-cli) on project rsb: MavenReportException: Error while generating Javadoc

The reasons seems to be that two new maven goals are generated into the job

before

-B install deploy dependency:copy-dependencies

now

-B install deploy dependency:copy-dependencies javadoc:jar source:jar

0.12 is affected. I dont know about the other versions. See the attached jenkins output for further details.

rsb-java-0.12-citk.txt Magnifier - jenkins output (147 KB) A. Neumann, 06/25/2015 03:43 PM

Associated revisions

Revision 73a68c46
Added by J. Wienke over 6 years ago

Fix javadoc generation with java 8

  • Disable doclint for java 8 using a maven profile. Doclint lacks
    configuration options to make detected problems a warning instead of
    an error which results in the fact that all files containing linter
    errors are not contained in the generated documentation. The generated
    protocol classes using protoc are full of javadoc errors and we cannot
    afford having them (and in turn all classes referencing these classes
    in their javadoc) excluded from the documentation.
  • Fix some obvious errors detected by doclint.

fixes #2327

Revision 9fe44db4
Added by J. Wienke over 6 years ago

Fix javadoc generation with java 8

  • Disable doclint for java 8 using a maven profile. Doclint lacks
    configuration options to make detected problems a warning instead of
    an error which results in the fact that all files containing linter
    errors are not contained in the generated documentation. The generated
    protocol classes using protoc are full of javadoc errors and we cannot
    afford having them (and in turn all classes referencing these classes
    in their javadoc) excluded from the documentation.
  • Fix some obvious errors detected by doclint.

fixes #2327

History

#1 Updated by J. Wienke over 6 years ago

Can you please show more output of your invocation? There must be some more error messages.

What I've seen a few days ago was a bug in javadoc from java6 which caused a crash of the javadoc tool. Try to ensure that your javadoc is at least from version 7.

#2 Updated by J. Wienke over 6 years ago

  • Category set to Java
  • Target version set to rsb-0.13

#3 Updated by A. Neumann over 6 years ago

- "Can you please show more output of your invocation? There must be some more error messages."
the whole output can be found in the file attached to this issue.

- "What I've seen a few days ago was a bug in javadoc from java6 which caused a crash of the javadoc tool. Try to ensure that your javadoc is at least from version 7"

We have used Java 8. The call can be found at the bottom of this file:

...
[ERROR] Command line was: /opt/Oracle_Java/jdk1.8.0_45/jre/../bin/javadoc @options @packages @argfile
...

If thats not the output you meant, give me a shout and i will happily gather more information if i can.

#4 Updated by A. Neumann over 6 years ago

Its 75 errors and 100 warnings starting from line 846

#5 Updated by J. Wienke over 6 years ago

Strangely, for me these are just reported as warnings and not as errors.

Could you please try to specify the maven property maven.javadoc.failOnError=false in the build to see whether this helps

#6 Updated by A. Neumann over 6 years ago

I added the property to rsb-java.project and now the job succeeds.


diff --git a/projects/rsb-java.project b/projects/rsb-java.project
index 99f24ad..fa98aad 100644
--- a/projects/rsb-java.project
+++ b/projects/rsb-java.project
@@ -26,6 +26,7 @@
                                      "failOnStyleError=false",
                                      "pbuf.protopath=${dependency-dir}/${protocol-dir}",
                                      "spread.daemon=${dependency-dir}/sbin/spread",
+                                    "maven.javadoc.failOnError=false",
                                      "@{next-value|[]}" ],
         "maven.targets":           [ "javadoc:jar", "source:jar", "@{next-value|[]}" ]
     },

Should I commit and push the change to the repository?

#7 Updated by J. Wienke over 6 years ago

It seems that with java 8 javadoc suddenly became much more strict about syntax errors. That's the reason why most others did not notice this.

You can add that line to the citk repo, but please with correct indentation. ;) Spaces only.

#8 Updated by J. Wienke over 6 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

Also available in: Atom PDF