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.

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

[Java] fix javadoc configuration #3302

Merged
merged 2 commits into from Jul 8, 2019

Conversation

Projects
None yet
2 participants
@jmini
Copy link
Member

commented Jul 8, 2019

Fixes #3299.

The special javadoc tag @http.response.details needs to be declared correctly, so that the javadoc can be built.


For maven, this PR changes where the <configuration> block is added.
It was inside the <execution> bloc, but the example in the documetation (Configuring Custom Javadoc Tags) adds it directly in the <plugin> bloc.

For gradle, the javadoc page do not really mention the tags option, but
GRADLE-1563 does. See also this question on stackoverflow.

@auto-labeler auto-labeler bot added the Client: Java label Jul 8, 2019

@auto-labeler

This comment has been minimized.

Copy link

commented Jul 8, 2019

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@jmini jmini force-pushed the jmini:issue3299-javadoc-config branch from 8dd7e8e to 9ba5cf1 Jul 8, 2019

@@ -12,6 +12,7 @@ if [ "$NODE_INDEX" = "1" ]; then
#cp CI/pom.xml.circleci pom.xml
java -version
mvn --quiet verify -Psamples.circleci
mvn --quiet javadoc:javadoc -Psamples.circleci

This comment has been minimized.

Copy link
@jmini

jmini Jul 8, 2019

Author Member

Discussed with @wing328 on Gitter, this is a way to check that Javadoc can be built

@wing328

wing328 approved these changes Jul 8, 2019

Copy link
Member

left a comment

The CircleCI failure is not related to this PR

@wing328 wing328 merged commit 3943d1c into OpenAPITools:master Jul 8, 2019

3 of 4 checks passed

ci/circleci Your tests failed on CircleCI
Details
Shippable Run 8993 status is SUCCESS.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@wing328 wing328 added this to the 4.0.3 milestone Jul 8, 2019

@jmini jmini deleted the jmini:issue3299-javadoc-config branch Jul 8, 2019

@wing328 wing328 changed the title [java] fix javadoc configuration [Java] fix javadoc configuration Jul 9, 2019

@jmini jmini referenced this pull request Jul 9, 2019

Open

[BUG][Java][client] `mvn package` fails on Javadoc error #3272

0 of 1 task complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.