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

jmini
Copy link
Member

@jmini jmini 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
Copy link

auto-labeler bot 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 issue3299-javadoc-config branch from 8dd7e8e to 9ba5cf1 Compare July 8, 2019 11:31
@@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CircleCI failure is not related to this PR

@wing328 wing328 merged commit 3943d1c into OpenAPITools:master Jul 8, 2019
@wing328 wing328 added this to the 4.0.3 milestone Jul 8, 2019
@jmini jmini deleted the issue3299-javadoc-config branch July 8, 2019 16:33
@wing328 wing328 changed the title [java] fix javadoc configuration [Java] fix javadoc configuration Jul 9, 2019
@Alex-e
Copy link
Contributor

Alex-e commented Jul 6, 2020

Not fixed for sbt.

error: unknown tag: http.response.details [error] * @http.response.details

Version 4.3.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][okhttp-gson] can not generate javadoc
3 participants