Skip to content

Changing the javadoc link to the JDK docs to be https causes OpenJDK11 to fail #7

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.

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

Closed
Capstan opened this issue Oct 29, 2019 · 4 comments · Fixed by #8
Closed

Changing the javadoc link to the JDK docs to be https causes OpenJDK11 to fail #7

Capstan opened this issue Oct 29, 2019 · 4 comments · Fixed by #8
Labels
enhancement New feature or request

Comments

@Capstan
Copy link

Capstan commented Oct 29, 2019

This is true on all the java-json-tools repositories. I'll put in an exact error message in a bit.

@Capstan Capstan added the enhancement New feature or request label Oct 29, 2019
Capstan added a commit to Capstan/btf that referenced this issue Oct 29, 2019
@Capstan
Copy link
Author

Capstan commented Oct 29, 2019

The error is javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/7/docs/api/ are in the unnamed module.

This doesn't repro on my dev box, so it's a PITA. It also gives the tantalizing Javadoc generation failed. Generated Javadoc options file (useful for troubleshooting): '/home/travis/build/java-json-tools/btf/build/tmp/javadoc/javadoc.options' but of course I don't have access to that file.

@Capstan
Copy link
Author

Capstan commented Oct 30, 2019

Instrumenting .travis.yml with

after_failure:
  - if [ -f /home/travis/build/java-json-tools/btf/build/tmp/javadoc/javadoc.options ]; then echo javadoc.options:; cat /home/travis/build/java-json-tools/btf/build/tmp/javadoc/javadoc.options; fi

allowed me to get the javadoc.options file contents:

-classpath '/home/travis/build/java-json-tools/btf/build/classes/java/main:/home/travis/build/java-json-tools/btf/build/resources/main:/home/travis/.gradle/caches/modules-2/files-2.1/com.google.code.findbugs/jsr305/2.0.1/516c03b21d50a644d538de0f0369c620989cd8f0/jsr305-2.0.1.jar'
-d '/home/travis/build/java-json-tools/btf/build/docs/javadoc'
-doctitle 'btf 1.3-SNAPSHOT API'
-link 'https://docs.oracle.com/javase/7/docs/api/'
-link 'https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.1/'
-quiet 
-windowtitle 'btf 1.3-SNAPSHOT API'
'/home/travis/build/java-json-tools/btf/src/main/java/com/github/fge/Thawed.java'
'/home/travis/build/java-json-tools/btf/src/main/java/com/github/fge/Frozen.java'
'/home/travis/build/java-json-tools/btf/src/main/java/com/github/fge/Builder.java'

Now I just have to figure how to pass the --release flag via gradle.

@Capstan
Copy link
Author

Capstan commented Oct 30, 2019

javadoc.options.addStringOption("-release", "7"); seems to work, though it's weird to have to prefix it with a '-'. Now I need to apply it only for OpenJDK9 or up.

@Capstan
Copy link
Author

Capstan commented Oct 30, 2019

Found gradle/gradle/issues/5891 which has a workaround that selects the JDK version.

Capstan added a commit to Capstan/btf that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

Fixes java-json-tools#7.
Capstan added a commit that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

Fixes #7.
Capstan added a commit to Capstan/msg-simple that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to java-json-tools/msg-simple that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to Capstan/uri-template that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to java-json-tools/uri-template that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to Capstan/jackson-coreutils that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.

Also fixes the reference to be to java-json-tools/msg-simple.
Capstan added a commit to java-json-tools/jackson-coreutils that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.

Also fixes the reference to be to java-json-tools/msg-simple.
Capstan added a commit to Capstan/json-schema-core that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to java-json-tools/json-schema-core that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to Capstan/json-schema-validator that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Capstan added a commit to java-json-tools/json-schema-validator that referenced this issue Oct 30, 2019
Conditionally adds a `--release=7` flag to tell javadoc the source compatibility. This inhibits javadoc in later JDKs erroring out expecting modules when there are none.

See java-json-tools/btf/issues/7.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant