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

Javadoc improvements for JMatrix 📚 #61

Merged
merged 4 commits into from
Jul 19, 2023

Conversation

mitsuki31
Copy link
Owner

@mitsuki31 mitsuki31 commented Jul 19, 2023

What's Changed

  • Javadoc documentation has been added to several classes to provide comprehensive explanations and improve code clarity.

    This update also addresses the documentation warning encountered during project linting.
    For more information, see Warning fixes for linting project #58.

All Commits
  • 046e9fa - Add and update the javadoc for Main
  • e26435c - Add and update the javadoc for OSUtils
  • 52e6ffa - Add and update the javadoc for XMLParser
  • a154dbd - Add and update the javadoc for Options

Summary

This set of changes focuses on enhancing code documentation by adding Javadoc to multiple classes. The newly added Javadoc provides comprehensive explanations for the respective classes, contributing to better code clarity and understanding.
Additionally, this update successfully resolves the documentation warning encountered during project linting (#58). The improvements in code documentation enhance the overall maintainability and readability of the codebase.

@mitsuki31 mitsuki31 self-assigned this Jul 19, 2023
@mitsuki31 mitsuki31 added documentation Improvements or additions to documentation bugfix Fixes some bug or issue lang:java Some changes on Java code labels Jul 19, 2023
@mitsuki31 mitsuki31 linked an issue Jul 19, 2023 that may be closed by this pull request
3 tasks
@mitsuki31 mitsuki31 marked this pull request as ready for review July 19, 2023 13:18
@mitsuki31 mitsuki31 merged commit ec1bd01 into master Jul 19, 2023
14 checks passed
@mitsuki31 mitsuki31 deleted the bugfix/fix-documentation-warning branch July 19, 2023 13:20
@mitsuki31 mitsuki31 mentioned this pull request Jul 19, 2023
3 tasks
@mitsuki31 mitsuki31 added the patch Patch update label Jul 19, 2023
@mitsuki31 mitsuki31 mentioned this pull request Aug 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fixes some bug or issue documentation Improvements or additions to documentation lang:java Some changes on Java code patch Patch update
Projects
No open projects
Status: Done 🏁
Development

Successfully merging this pull request may close these issues.

Warning fixes for linting project
1 participant