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

docs(bindings/java): better javadoc #5572

Merged
merged 2 commits into from
Jan 26, 2025
Merged

docs(bindings/java): better javadoc #5572

merged 2 commits into from
Jan 26, 2025

Conversation

tisonkun
Copy link
Member

AS IS

///
/// ## Url
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 can hardly handle headings. Update the comment in an identical expressed way.

@tisonkun
Copy link
Member Author

Preview:

image

You can test locally with:

cd bindings/java
./mvnw site
./mvnw javadoc:javadoc
open target/site/apidocs/org/apache/opendal/ServiceConfig.Mysql.html

Copy link

codspeed-hq bot commented Jan 26, 2025

CodSpeed Performance Report

Merging #5572 will degrade performances by 18.88%

Comparing better-docs (d34a03c) with main (1026d8a)

Summary

⚡ 4 improvements
❌ 12 regressions
✅ 57 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark BASE HEAD Change
buffer 256 KiB * 32 chunk 125.3 ns 154.4 ns -18.88%
buffer 256 KiB * 4 chunk 125.3 ns 154.4 ns -18.88%
buffer 4.00 MiB * 32 chunk 125.3 ns 154.4 ns -18.88%
buffer 4.00 MiB * 4 chunk 125.3 ns 154.4 ns -18.88%
bytes buf 256 KiB * 32 advance 464.2 ns 405.8 ns +14.37%
bytes buf 256 KiB * 4 advance 464.2 ns 405.8 ns +14.37%
bytes buf 4.00 MiB * 32 advance 464.2 ns 405.8 ns +14.37%
bytes buf 4.00 MiB * 4 advance 464.2 ns 405.8 ns +14.37%
256 KiB * 1000k chunk 125.3 ns 154.4 ns -18.88%
256 KiB * 1000k truncate 216.7 ns 245.8 ns -11.86%
256 KiB * 100k chunk 125.3 ns 154.4 ns -18.88%
256 KiB * 100k truncate 216.7 ns 245.8 ns -11.86%
256 KiB * 10k chunk 125.3 ns 154.4 ns -18.88%
256 KiB * 10k truncate 216.7 ns 245.8 ns -11.86%
256 KiB * 1k chunk 154.4 ns 183.6 ns -15.89%
256 KiB * 1k truncate 216.7 ns 245.8 ns -11.86%

@tisonkun tisonkun merged commit cdbcc0f into main Jan 26, 2025
279 of 280 checks passed
@tisonkun tisonkun deleted the better-docs branch January 26, 2025 04:01
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.

2 participants