Skip to content

Added missing Javadoc for public return value #431

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
Merged
merged 1 commit into from
Apr 11, 2022
Merged

Added missing Javadoc for public return value #431

merged 1 commit into from
Apr 11, 2022

Conversation

Zabuzard
Copy link
Member

@Zabuzard Zabuzard commented Apr 6, 2022

Overview

Closes #430.

Our Sonar is currently failing due to a missing Javadoc for a return value of a public method:

report

This was originally merged by #296. But nobody noticed back then, since our Sonar config was incorrect until recently.

This fixes the issue by adding the Javadoc, easy money.

@Zabuzard Zabuzard added bug Something isn't working documentation Improvements or additions to documentation priority: major labels Apr 6, 2022
@Zabuzard Zabuzard requested a review from a team April 6, 2022 07:05
@Zabuzard Zabuzard requested a review from a team as a code owner April 6, 2022 07:05
@Zabuzard Zabuzard self-assigned this Apr 6, 2022
@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 6, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@Tais993
Copy link
Member

Tais993 commented Apr 6, 2022

When has our sonarcloud config been changed then?

@Zabuzard
Copy link
Member Author

Zabuzard commented Apr 6, 2022

When has our sonarcloud config been changed then?

I changed it maybe a 2-4 weeks ago. It used master as main branch instead of develop and the quality gate was missing a rule to fail for "critical issues" (such as the public javadoc rule). It only had security issues as reason to fail the gate.

@Zabuzard Zabuzard mentioned this pull request Apr 6, 2022
Closed
@Zabuzard Zabuzard merged commit d14a7bc into develop Apr 11, 2022
@Zabuzard Zabuzard deleted the bugfix/missing_javadoc_return_value branch April 11, 2022 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tais993 Tais993 Tais993 left review comments

@marko-radosavljevic marko-radosavljevic marko-radosavljevic approved these changes

Assignees

@Zabuzard Zabuzard

Labels
bug Something isn't working documentation Improvements or additions to documentation priority: major
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Sonar - Missing Javadoc for public return value
3 participants
@Zabuzard @Tais993 @marko-radosavljevic