Checkstyle Results
The following document contains the results of Checkstyle 9.3 with /home/runner/work/maven-project-utilities/maven-project-utilities/multi-module-build/multi-module-build-web/../dev-ops/maven/site-config/checkstyle.xml ruleset.
Summary
| Files |  Info |
 Warnings |
 Errors |
|---|---|---|---|
| 4 | 0 | 0 | 16 |
Files
| File | I |
W |
E |
|---|---|---|---|
| application-dev.properties | 0 | 0 | 1 |
| application.properties | 0 | 0 | 1 |
| com/garbuz/web/WebApplication.java | 0 | 0 | 4 |
| com/garbuz/web/controller/HomeController.java | 0 | 0 | 10 |
Rules
| Category | Rule | Violations | Severity |
|---|---|---|---|
| design | DesignForExtension | 2 | Error |
| javadoc | JavadocPackage | 2 | Error |
| MissingJavadocMethod | 3 | Error | |
| misc | FinalParameters | 4 | Error |
| NewlineAtEndOfFile | 4 | Error | |
| regexp | RegexpSingleline
|
1 | Error |
Details
application-dev.properties
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
misc | NewlineAtEndOfFile | File does not end with a newline. | 1 |
application.properties
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
misc | NewlineAtEndOfFile | File does not end with a newline. | 1 |
com/garbuz/web/WebApplication.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
misc | NewlineAtEndOfFile | File does not end with a newline. | 1 |
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | 1 |
| Error |
javadoc | MissingJavadocMethod | Missing a Javadoc comment. | 10 |
| Error |
misc | FinalParameters | Parameter args should be final. | 10 |
com/garbuz/web/controller/HomeController.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
misc | NewlineAtEndOfFile | File does not end with a newline. | 1 |
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | 1 |
| Error |
design | DesignForExtension | Class 'HomeController' looks like designed for extension (can be subclassed), but the method 'home' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'HomeController' final or making the method 'home' static/final/abstract/empty, or adding allowed annotation for the method. | 11 |
| Error |
javadoc | MissingJavadocMethod | Missing a Javadoc comment. | 11 |
| Error |
misc | FinalParameters | Parameter model should be final. | 12 |
| Error |
design | DesignForExtension | Class 'HomeController' looks like designed for extension (can be subclassed), but the method 'hello' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'HomeController' final or making the method 'hello' static/final/abstract/empty, or adding allowed annotation for the method. | 18 |
| Error |
javadoc | MissingJavadocMethod | Missing a Javadoc comment. | 18 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 19 |
| Error |
misc | FinalParameters | Parameter name should be final. | 19 |
| Error |
misc | FinalParameters | Parameter model should be final. | 20 |