st-tu-dresden / salespoint

A framework to develop point of sales applications, powered by Java and Spring Boot
https://tu-dresden.de/ing/informatik/smt/st/forschung/forschungsprojekte/salespoint
Apache License 2.0
178 stars 49 forks source link

Use stricter doclint settings and fix found Javadoc issues #422

Closed martinmo closed 1 year ago

martinmo commented 1 year ago

As proposed in #416 I have configured maven-javadoc-plugin to be stricter and also fail the build if there are warnings regarding the Javadoc, with the goal to automatically prevent obvious inconsistencies between code and Javadoc in the future.

@odrotbohm could you please have a look at the changes and say if you're okay with them? I've split the changes across smaller commits for easier review. They can of course be squashed into one commit for the merge into main.

Fixes: #416

sonarcloud[bot] commented 1 year ago

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