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

Add timeout units to Javadoc comments #1778

Merged

Conversation

noah-livio
Copy link
Contributor

@noah-livio noah-livio commented Dec 16, 2021

Fixes #1775

This PR is ready for review.

Risk

This PR makes no API changes.

Testing Plan

  • I have verified that I have not introduced new warnings in this PR (or explain why below)
  • I have run the unit tests with this PR - N/A
  • I have tested this PR against Core and verified behavior (if applicable, if not applicable, explain why below).
  • I have tested Android, Java SE, and Java EE

Unit Tests

N/A - This PR only changes documentation, not runnable code.

Core Tests

N/A - This PR only changes documentation, not runnable code.

Core version / branch / commit hash / module tested against: N/A
HMI name / version / branch / commit hash / module tested against: N/A

Summary

This PR adds the units (milliseconds) to the Javadoc comments related to timeouts in ScrollableMessage

Changelog

Breaking Changes
  • None
Enhancements
  • Better documentation
Bug Fixes

Tasks Remaining:

  • None

CLA

Copy link
Contributor

@bilal-alsharifi bilal-alsharifi left a comment

Choose a reason for hiding this comment

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

It seems that the Slider RPC is also missing timeout unit

@noah-livio
Copy link
Contributor Author

Fixes #1775

This PR is ready for review.

Risk

This PR makes no API changes.

Testing Plan

  • I have verified that I have not introduced new warnings in this PR (or explain why below)
  • I have run the unit tests with this PR - N/A
  • I have tested this PR against Core and verified behavior (if applicable, if not applicable, explain why below).
  • I have tested Android, Java SE, and Java EE

Unit Tests

N/A - This PR only changes documentation, not runnable code.

Core Tests

N/A - This PR only changes documentation, not runnable code.

Core version / branch / commit hash / module tested against: N/A
HMI name / version / branch / commit hash / module tested against: N/A

Summary

This PR adds the units (milliseconds) to the Javadoc comments related to timeouts in ScrollableMessage and Slider classes

Changelog

Breaking Changes
  • None
Enhancements
  • Better documentation
Bug Fixes

Tasks Remaining:

  • None

CLA

@codecov
Copy link

codecov bot commented Jan 6, 2022

Codecov Report

Merging #1778 (ab50c0e) into develop (b2b1e59) will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##             develop    #1778      +/-   ##
=============================================
- Coverage      54.36%   54.33%   -0.04%     
+ Complexity      5509     5507       -2     
=============================================
  Files            562      562              
  Lines          25516    25516              
  Branches        3319     3319              
=============================================
- Hits           13873    13865       -8     
- Misses         10384    10392       +8     
  Partials        1259     1259              
Impacted Files Coverage Δ
...m/smartdevicelink/proxy/rpc/ScrollableMessage.java 84.21% <ø> (ø)
...ain/java/com/smartdevicelink/proxy/rpc/Slider.java 81.48% <ø> (ø)
...rtdevicelink/streaming/video/SdlRemoteDisplay.java 45.12% <0.00%> (-7.32%) ⬇️
...nk/managers/audio/AudioDecoderCompatOperation.java 75.00% <0.00%> (-4.55%) ⬇️

@bilal-alsharifi bilal-alsharifi merged commit 039503d into smartdevicelink:develop Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants