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

docs: improve Javadocs across multiple classes #181

Merged
merged 1 commit into from
Feb 13, 2025
Merged

docs: improve Javadocs across multiple classes #181

merged 1 commit into from
Feb 13, 2025

Conversation

groldan
Copy link
Member

@groldan groldan commented Feb 13, 2025

  • Add missing Javadocs for public classes, methods, and fields
  • Improve clarity, consistency, and formatting in existing Javadocs
  • Ensure compliance with project documentation standards:
    • No trailing spaces in Javadoc lines and empty lines
    • Include relevant @see references for related classes
    • Provide structured explanations for complex logic
    • Add example JSON responses where applicable
  • Ensure a newline at the end of files after the last class' closing brace

This commit enhances maintainability and readability by ensuring well-documented code.

@groldan groldan added documentation Improvements or additions to documentation gardening labels Feb 13, 2025
@groldan groldan force-pushed the javadocs branch 3 times, most recently from 34fa585 to 28062fc Compare February 13, 2025 07:33
@groldan groldan marked this pull request as ready for review February 13, 2025 07:37
pmauduit
pmauduit approved these changes Feb 13, 2025
View reviewed changes
Copy link
Member

@pmauduit pmauduit left a comment

Choose a reason for hiding this comment

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

thanks for this huge work

@pmauduit
Copy link
Member

Maybe we could also address the forgotten #177 (comment) from the other PR.

@groldan
docs: improve Javadocs across multiple classes
052a1da 
- Add missing Javadocs for public classes, methods, and fields
- Improve clarity, consistency, and formatting in existing Javadocs
- Ensure compliance with project documentation standards:
  - No trailing spaces in Javadoc lines and empty lines
  - Include relevant `@see` references for related classes
  - Provide structured explanations for complex logic
  - Add example JSON responses where applicable
- Ensure a newline at the end of files after the last class' closing brace

This commit enhances maintainability and readability by ensuring well-documented code.
@groldan groldan merged commit 2f86428 into main Feb 13, 2025
3 checks passed
@groldan groldan deleted the javadocs branch February 13, 2025 17:14
@fvanderbiest
Copy link
Member

Impressive ...
AI assisted generation ?

@groldan
Copy link
Member Author

groldan commented Feb 24, 2025

AI assisted generation ?

of course. It was several hours nonetheless

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

@pmauduit pmauduit pmauduit approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation gardening
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@groldan @pmauduit @fvanderbiest