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

ARROW-17787: [Java] Fix Javadoc build #14212

Merged
merged 1 commit into from
Sep 23, 2022
Merged

Conversation

lidavidm
Copy link
Member

@lidavidm lidavidm commented Sep 22, 2022

Don't document the javadocs to avoid errors when there is nothing documentable in the javadocs

* Don't document the javadocs to avoid errors when there is nothing
  documentable in the javadocs
@github-actions
Copy link

@lidavidm lidavidm marked this pull request as ready for review September 22, 2022 22:46
@@ -688,7 +688,6 @@
<reportSet><!-- by default, id = "default" -->
<reports><!-- select non-aggregate reports -->
<report>javadoc</report>
<report>test-javadoc</report>
Copy link
Collaborator

Choose a reason for hiding this comment

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

@lidavidm just for my understanding: why this fixes the issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

Javadoc errors if it doesn't find any public classes to document, JUnit 5 means that test classes no longer need to be public, so the easiest solution is to just not document test code

Copy link
Collaborator

Choose a reason for hiding this comment

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

Got it. Thanks.

@lidavidm lidavidm merged commit bed6f8e into apache:master Sep 23, 2022
@lidavidm lidavidm deleted the arrow-17787 branch September 23, 2022 13:50
@ursabot
Copy link

ursabot commented Sep 23, 2022

Benchmark runs are scheduled for baseline = 485128f and contender = bed6f8e. bed6f8e is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed ⬇️0.61% ⬆️0.03%] test-mac-arm
[Failed ⬇️0.55% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.25% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] bed6f8e5 ec2-t3-xlarge-us-east-2
[Finished] bed6f8e5 test-mac-arm
[Failed] bed6f8e5 ursa-i9-9960x
[Finished] bed6f8e5 ursa-thinkcentre-m75q
[Finished] 485128f0 ec2-t3-xlarge-us-east-2
[Failed] 485128f0 test-mac-arm
[Failed] 485128f0 ursa-i9-9960x
[Finished] 485128f0 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

zagto pushed a commit to zagto/arrow that referenced this pull request Oct 7, 2022
Don't document the javadocs to avoid errors when there is nothing documentable in the javadocs

Authored-by: David Li <[email protected]>
Signed-off-by: David Li <[email protected]>
fatemehp pushed a commit to fatemehp/arrow that referenced this pull request Oct 17, 2022
Don't document the javadocs to avoid errors when there is nothing documentable in the javadocs

Authored-by: David Li <[email protected]>
Signed-off-by: David Li <[email protected]>
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.

4 participants