search

Together-Java / TJ-Bot

TJ-Bot is a Discord Bot used on the Together Java server. It is maintained by the community, anyone can contribute.
https://togetherjava.org
GNU General Public License v3.0
100 stars 89 forks source link

Sonar - Missing public Javadoc #432

Closed Zabuzard closed 2 years ago

Zabuzard commented 2 years ago

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.

github-actions[bot] commented 2 years ago

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.

Zabuzard commented 2 years ago

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

marko-radosavljevic commented 2 years ago

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.

Zabuzard commented 2 years ago

done