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.

Sign up for GitHub

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

Jump to bottom

Added lots of javadoc #1628

Draft
wants to merge 12 commits into
base: develop
Choose a base branch
from
Draft

Added lots of javadoc #1628

wants to merge 12 commits into from

Conversation

peter-lawrey
Copy link
Member

No description provided.

@peter-lawrey peter-lawrey marked this pull request as draft October 30, 2024 15:24
@peter-lawrey
Copy link
Member Author

Need to merge #1629 first

@peter-lawrey
Copy link
Member Author

Also this needs to be merged first #1630

@tgd tgd requested review from james-mcsherry and batespj November 4, 2024 15:59
tgd
tgd requested changes Nov 4, 2024
View reviewed changes
Copy link
Contributor

@tgd tgd left a comment

Choose a reason for hiding this comment

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

A good improvement to the javadocs! Some feedback:

  • Its possible to extract constants in various parts of the PR
  • Some javadoc is overly verbose and describes what is already visible from the code - its not worth doubling up this information with javadoc

src/main/java/net/openhft/chronicle/queue/BufferMode.java Outdated Show resolved Hide resolved
src/main/java/net/openhft/chronicle/queue/ChronicleHistoryReaderMain.java Outdated Show resolved Hide resolved
src/main/java/net/openhft/chronicle/queue/ChronicleHistoryReaderMain.java Outdated Show resolved Hide resolved
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Nov 8, 2024

Quality Gate Passed Quality Gate passed

Issues
31 New issues
0 Accepted issues

Measures
0 Security Hotspots
72.3% Coverage on New Code
0.5% Duplication on New Code

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tgd tgd tgd requested changes

@james-mcsherry james-mcsherry james-mcsherry approved these changes

@keiran-lawrey keiran-lawrey Awaiting requested review from keiran-lawrey

@batespj batespj Awaiting requested review from batespj

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@peter-lawrey @tgd @james-mcsherry @keiran-lawrey