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: Update and extension of Javadocs for entities #355

Merged
merged 1 commit into from
Dec 11, 2023

Conversation

o-kopysov
Copy link
Collaborator

@o-kopysov o-kopysov commented Dec 8, 2023

Pull Request

Description

This PR extends Javadocs for all entity classes and enums.
Related to #307.
Also, refactored source code where needed.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code cleanup/refactoring
  • Documentation update
  • This change requires a documentation update
  • CI system update
  • Test Coverage update

Checklist:

  • My code follows the style guidelines of this project
  • My code meets the required code coverage for lines (90% and above)
  • My code meets the required code coverage for branches (80% and above)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@o-kopysov o-kopysov added the documentation Improvements or additions to documentation label Dec 8, 2023
@o-kopysov o-kopysov added this to the v1.3.0 milestone Dec 8, 2023
@o-kopysov o-kopysov self-assigned this Dec 8, 2023
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6600bd2) 91.36% compared to head (8fab7f7) 91.34%.

Additional details and impacted files
@@             Coverage Diff              @@
##               main     #355      +/-   ##
============================================
- Coverage     91.36%   91.34%   -0.02%     
+ Complexity      478      475       -3     
============================================
  Files            49       48       -1     
  Lines          1609     1606       -3     
  Branches        194      194              
============================================
- Hits           1470     1467       -3     
  Misses           82       82              
  Partials         57       57              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@o-kopysov o-kopysov marked this pull request as ready for review December 8, 2023 12:05
Copy link
Collaborator

@o-konoval o-konoval left a comment

Choose a reason for hiding this comment

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

Great job! Approved!

@o-kopysov o-kopysov merged commit ce2f7ae into Samsung:main Dec 11, 2023
7 checks passed
@o-kopysov o-kopysov deleted the add-javadoc branch December 11, 2023 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants