Skip to content

Enhanced documentation for Java classes #854

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
Merged
stleary merged 1 commit into from
Feb 13, 2024
Merged

Enhanced documentation for Java classes #854

stleary merged 1 commit into from
Feb 13, 2024

Conversation

@javadev
Copy link
Contributor

@javadev javadev commented Feb 2, 2024

No description provided.

@javadev
Copy link
Contributor Author

javadev commented Feb 2, 2024

I have tested it locally

[INFO] >>> maven-javadoc-plugin:3.5.0:javadoc (default-cli) > generate-sources @ json >>>
[INFO] 
[INFO] <<< maven-javadoc-plugin:3.5.0:javadoc (default-cli) < generate-sources @ json <<<
[INFO] 
[INFO] 
[INFO] --- maven-javadoc-plugin:3.5.0:javadoc (default-cli) @ json ---
[INFO] No previous run data found, generating javadoc.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.844 s
[INFO] Finished at: 2024-02-02T09:07:20+02:00
[INFO] ------------------------------------------------------------------------

@javadev javadev mentioned this pull request Feb 2, 2024
Closed
@stleary
Copy link
Owner

stleary commented Feb 2, 2024

Looks like one of the unit tests is failing when executed with Java 11. This will be fixed in a separate PR.

stleary
stleary reviewed Feb 2, 2024
View reviewed changes
@javadev javadev requested a review from stleary February 7, 2024 13:17
@stleary
Copy link
Owner

stleary commented Feb 10, 2024

What problem does this code solve?
Addresses compiler warnings by adding JavaDoc comments to some methods

Does the code still compile with Java6?
Yes, but there is a pom.xml change that specifies Java 8, to fix a compiler warning.
This will be reverted in a follow-on commit.

Risks
Low

Changes to the API?
No

Will this require a new release?
No

Should the documentation be updated?
No

Does it break the unit tests?
No

Was any code refactored in this commit?
No

Review status
APPROVED

Starting 3-day comment window

@stleary stleary merged commit 6358b7f into stleary:master Feb 13, 2024
@stleary stleary mentioned this pull request Feb 14, 2024
Merged
stleary added a commit that referenced this pull request Feb 17, 2024
@stleary
Merge pull request #858 from stleary/cleanup-after-commit
77c899d 
cleanup-after-commit for #854 and #856
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stleary stleary stleary approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@javadev @stleary