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: Add Javadoc comments for services #360

Merged
merged 1 commit into from
Dec 15, 2023

Conversation

o-kopysov
Copy link
Collaborator

Pull Request

Description

Current PR contains final updates in Javadoc comments and covers all services.

Fixes #307

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 14, 2023
@o-kopysov o-kopysov added this to the v1.3.0 milestone Dec 14, 2023
@o-kopysov o-kopysov self-assigned this Dec 14, 2023
Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b569962) 91.34% compared to head (0cdf65e) 91.34%.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #360   +/-   ##
=========================================
  Coverage     91.34%   91.34%           
  Complexity      475      475           
=========================================
  Files            48       48           
  Lines          1606     1606           
  Branches        194      194           
=========================================
  Hits           1467     1467           
  Misses           82       82           
  Partials         57       57           

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

Copy link
Collaborator

@tdrozdovsky tdrozdovsky left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@m-rudyk m-rudyk left a comment

Choose a reason for hiding this comment

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

Approved

@o-kopysov o-kopysov merged commit 6298473 into Samsung:main Dec 15, 2023
7 checks passed
@o-kopysov o-kopysov deleted the javadoc-service branch December 15, 2023 08:48
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.

Javadoc comments extension
4 participants