TJ-Bot icon indicating copy to clipboard operation
TJ-Bot copied to clipboard

Sonar - Missing public Javadoc

Open Zabuzard opened this issue 3 years ago • 3 comments

Overview

Our Sonar rules recently changed and it now detects 47 missing Javadocs for public entities:

https://sonarcloud.io/project/issues?resolved=false&severities=CRITICAL&types=CODE_SMELL&id=Together-Java_TJ-Bot

Only one of them is recent enough to actually fail the Quality Gate (#431), but we should also fix the others. Most of them are from the logviewer project.

Zabuzard avatar Apr 06 '22 07:04 Zabuzard

This issue is stale because it has been open 30 days with no activity. Remove stale label, comment or add the valid label or this will be closed in 5 days.

github-actions[bot] avatar May 07 '22 07:05 github-actions[bot]

Logviewer is gone (for now). The remaining issues are from the formatter project. @illuminator3

Zabuzard avatar Oct 07 '22 09:10 Zabuzard

Probably the best bet is to integrate formatter module into application module, since it's an only outlier, every other feature is in there. And we do a round of reviews in that PR, to align the formatter feature with the rest of the codebase, and fix all sonar issues.

Of course, only if there is a will to actually finish that feature, and I think there is. It's an awesome feature. I'm just worried that nobody except illu can maintain it, which is not something we want.

marko-radosavljevic avatar Oct 07 '22 12:10 marko-radosavljevic

done

Zabuzard avatar Nov 08 '22 13:11 Zabuzard