Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Javadoc task fails when building with JDK 1.8 #75

Closed
rektide opened this issue Nov 17, 2014 · 4 comments
Closed

Javadoc task fails when building with JDK 1.8 #75

rektide opened this issue Nov 17, 2014 · 4 comments

Comments

@rektide
Copy link

rektide commented Nov 17, 2014

From a ant -Dversion=1.3-redhat-1 bundle (to try to make a bundle to use a
org.hamcrest:hamcrest-core:jar:1.3-redhat that jnr-enxio is requires):

javadoc:
  [javadoc] Generating Javadoc
  [javadoc] Javadoc execution
  [javadoc] Loading source files for package org.hamcrest.generator...
  [javadoc] Loading source files for package org.hamcrest.generator.config...
  [javadoc] Constructing Javadoc information...
  [javadoc] Creating destination directory: "/usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-javadoc.jar.contents/"
  [javadoc] Standard Doclet version 1.8.0_25
  [javadoc] Building tree for all the packages and classes...
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:34: warning: no @throws for java.io.IOException
  [javadoc]     void writeHeader() throws IOException;
  [javadoc]          ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:39: warning: no description for @param
  [javadoc]      * @param generatedMethodName
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:40: warning: no description for @param
  [javadoc]      * @param factoryMethodToDelegateTo
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:42: warning: no @throws for java.io.IOException
  [javadoc]     void writeMethod(String generatedMethodName, FactoryMethod factoryMethodToDelegateTo) throws IOException;
  [javadoc]          ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:47: warning: no @throws for java.io.IOException
  [javadoc]     void writeFooter() throws IOException;
  [javadoc]          ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:38: warning: no @return
  [javadoc]     public String getMatcherClass() {
  [javadoc]                   ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:53: warning: no @return
  [javadoc]     public String getName() {
  [javadoc]                   ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:65: warning: no @return
  [javadoc]     public String getGenerifiedType() {
  [javadoc]                   ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:75: error: invalid entity &ht;
  [javadoc]      * ie. 'public Matcher<...&ht;> blah(THIS, AND, THAT)'
  [javadoc]                                  ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:75: error: bad use of '>'
  [javadoc]      * ie. 'public Matcher<...&ht;> blah(THIS, AND, THAT)'
  [javadoc]                                      ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:77: warning: no @return
  [javadoc]     public List<Parameter> getParameters() {
  [javadoc]                            ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:89: warning: no @return
  [javadoc]     public List<String> getExceptions() {
  [javadoc]                         ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:101: warning: no @return
  [javadoc]     public List<String> getGenericTypeParameters() {
  [javadoc]                         ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:115: warning: no @return
  [javadoc]     public String getJavaDoc() {
  [javadoc]                   ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:9: error: self-closing element not allowed
  [javadoc]  * <p/>
  [javadoc]    ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:9: warning: empty <p> tag
  [javadoc]  * <p/>
  [javadoc]    ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:197: warning: no @return
  [javadoc]         public String getType() {
  [javadoc]                       ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryMethod.java:205: warning: no @return
  [javadoc]         public String getName() {
  [javadoc]                       ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/FactoryWriter.java:15: error: tag not allowed here: <p>
  [javadoc]  * <p/>
  [javadoc]    ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:93: error: self-closing element not allowed
  [javadoc]      * <p/>
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:93: warning: empty <p> tag
  [javadoc]      * <p/>
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:98: error: self-closing element not allowed
  [javadoc]      * <p/>
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:98: warning: empty <p> tag
  [javadoc]      * <p/>
  [javadoc]        ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:101: warning: no @param for javaMethod
  [javadoc]     protected boolean isFactoryMethod(JavaMethod javaMethod) {
  [javadoc]                       ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/QDoxFactoryReader.java:101: warning: no @return
  [javadoc]     protected boolean isFactoryMethod(JavaMethod javaMethod) {
  [javadoc]                       ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/SugarGenerator.java:62: error: reference not found
  [javadoc]      * @see ReflectiveFactoryReader
  [javadoc]             ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/SugarGenerator.java:87: warning: no @throws for java.io.IOException
  [javadoc]     public void generate() throws IOException {
  [javadoc]                 ^
  [javadoc] /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-sources.jar.contents/org/hamcrest/generator/SugarGen
   11095 14-11-16 20:05:06 -0500 [master]
   pdebuildx-amd64:/usr/local//a�
erator.java:44: error: reference not found
  [javadoc]  * @see ReflectiveFactoryReader
  [javadoc]         ^
  [javadoc] Building index for all the packages and classes...
  [javadoc] Building index for all classes...
  [javadoc] Generating /usr/local/src/hamcrest-git/build/temp/hamcrest-generator-1.3-redhat-1-javadoc.jar.contents/help-doc.html...
  [javadoc] 8 errors
  [javadoc] 20 warnings

BUILD FAILED
/usr/local/src/hamcrest-git/build.xml:118: The following error occurred while executing this line:
/usr/local/src/hamcrest-git/build.xml:256: Javadoc returned 1

Total time: 49 seconds
@rektide rektide changed the title Javadoc task fais Javadoc task fails Nov 17, 2014
@rektide rektide mentioned this issue Nov 17, 2014
Closed
@npryce npryce changed the title Javadoc task fails Javadoc task fails when building with JDK 1.8 Nov 23, 2014
@npryce
Copy link
Contributor

npryce commented Nov 23, 2014

Appears to be related to running with JDK 1.8.

npryce added a commit that referenced this issue Nov 23, 2014
@npryce
Disable doclint in javadoc build, so that it works on JDK 1.8. See is…
2df96c1 
…sue #75
@npryce
Copy link
Contributor

npryce commented Nov 23, 2014

Disabled doclint when running Javadoc on JDK 1.8.

@npryce npryce closed this as completed Nov 23, 2014
@npryce npryce reopened this Nov 24, 2014
@npryce
Copy link
Contributor

npryce commented Nov 24, 2014

Broken in Travis.ci. Need to tweak the Ant task to work in both JDK 1.8 and below. Or (better) fix the lint warnings/errors

npryce added a commit that referenced this issue Nov 25, 2014
@npryce
Issue #75 - Addressed doclint errors that break the build in JDK 1.8.
dbebced
@npryce
Copy link
Contributor

npryce commented Nov 25, 2014

Fixed doclint errors in master

@npryce npryce closed this as completed Nov 25, 2014
@Flamefire Flamefire mentioned this issue Jan 10, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rektide @npryce