Checkstyle Results

The following document contains the results of Checkstyle 9.3 with config/checkstyle/checkstyle.xml ruleset.

Summary

Files  Info  Warnings  Errors
50 0 63 0

Files

File  I  W  E
com/ericbouchut/learndev/LearnDevApplication.java 0 1 0
com/ericbouchut/learndev/admin/AccountAdminService.java 0 1 0
com/ericbouchut/learndev/admin/AdminController.java 0 1 0
com/ericbouchut/learndev/audit/entity/AuditLog.java 0 1 0
com/ericbouchut/learndev/audit/repository/AuditLogRepository.java 0 1 0
com/ericbouchut/learndev/auth/AuthController.java 0 5 0
com/ericbouchut/learndev/auth/CustomUserDetailsService.java 0 1 0
com/ericbouchut/learndev/auth/EmailVerificationMailer.java 0 3 0
com/ericbouchut/learndev/auth/EmailVerificationService.java 0 1 0
com/ericbouchut/learndev/auth/LoginAttemptListener.java 0 1 0
com/ericbouchut/learndev/auth/PasswordResetController.java 0 1 0
com/ericbouchut/learndev/auth/PasswordResetMailer.java 0 2 0
com/ericbouchut/learndev/auth/PasswordResetService.java 0 2 0
com/ericbouchut/learndev/auth/RegistrationService.java 0 4 0
com/ericbouchut/learndev/auth/entity/EmailToken.java 0 1 0
com/ericbouchut/learndev/auth/entity/PasswordResetToken.java 0 1 0
com/ericbouchut/learndev/auth/repository/EmailTokenRepository.java 0 1 0
com/ericbouchut/learndev/auth/repository/PasswordResetTokenRepository.java 0 1 0
com/ericbouchut/learndev/common/config/CacheConfig.java 0 1 0
com/ericbouchut/learndev/common/config/SecurityConfig.java 0 4 0
com/ericbouchut/learndev/course/CourseController.java 0 1 0
com/ericbouchut/learndev/course/CourseService.java 0 1 0
com/ericbouchut/learndev/course/InstructorCourseService.java 0 3 0
com/ericbouchut/learndev/course/MarkdownRenderer.java 0 3 0
com/ericbouchut/learndev/course/entity/Course.java 0 2 0
com/ericbouchut/learndev/course/entity/Enrollment.java 0 3 0
com/ericbouchut/learndev/course/entity/EnrollmentStatus.java 0 1 0
com/ericbouchut/learndev/course/entity/Lesson.java 0 1 0
com/ericbouchut/learndev/course/entity/PublicationStatus.java 0 1 0
com/ericbouchut/learndev/course/repository/CourseRepository.java 0 1 0
com/ericbouchut/learndev/course/repository/EnrollmentRepository.java 0 1 0
com/ericbouchut/learndev/course/repository/LessonRepository.java 0 1 0
com/ericbouchut/learndev/legal/LegalController.java 0 1 0
com/ericbouchut/learndev/role/entity/Role.java 0 2 0
com/ericbouchut/learndev/role/repository/RoleRepository.java 0 1 0
com/ericbouchut/learndev/user/entity/User.java 0 3 0
com/ericbouchut/learndev/user/repository/UserRepository.java 0 3 0

Rules

Category Rule Violations Severity
coding VariableDeclarationUsageDistance 2  Warning
imports AvoidStarImport 8  Warning
javadoc JavadocParagraph 7  Warning
JavadocTagContinuationIndentation 1  Warning
MissingJavadocMethod
  • scope: "public"
  • tokens: "METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"
  • minLineCount: "2"
  • allowedAnnotations: "Override, Test"
 15  Warning
MissingJavadocType
  • scope: "protected"
  • excludeScope: "nothing"
  • tokens: "CLASS_DEF, INTERFACE_DEF, ENUM_DEF, RECORD_DEF, ANNOTATION_DEF"
 14  Warning
NonEmptyAtclauseDescription 1  Warning
RequireEmptyLineBeforeBlockTagGroup 6  Warning
SummaryJavadoc
  • forbiddenSummaryFragments: "^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"
 2  Warning
sizes LineLength
  • fileExtensions: "java"
  • max: "100"
  • ignorePattern: "^package.*|^import.*|a href|href|http://|https://|ftp://"
 5  Error
whitespace EmptyLineSeparator
  • allowNoEmptyLineBetweenFields: "true"
  • tokens: "PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF"
 2  Warning

Details

com/ericbouchut/learndev/LearnDevApplication.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 6

com/ericbouchut/learndev/admin/AccountAdminService.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 34

com/ericbouchut/learndev/admin/AdminController.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 48

com/ericbouchut/learndev/audit/entity/AuditLog.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4

com/ericbouchut/learndev/audit/repository/AuditLogRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 6

com/ericbouchut/learndev/auth/AuthController.java

Severity Category Rule Message Line
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@return' should be preceded with an empty line. 39
 Warning javadoc JavadocTagContinuationIndentation Line continuation have incorrect indentation level, expected level should be 4. 40
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@return' should be preceded with an empty line. 49
 Warning javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 58
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@param' should be preceded with an empty line. 58

com/ericbouchut/learndev/auth/CustomUserDetailsService.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 12

com/ericbouchut/learndev/auth/EmailVerificationMailer.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 22
 Warning sizes LineLength Line is longer than 100 characters (found 106). 24
 Warning javadoc SummaryJavadoc Summary javadoc is missing. 30

com/ericbouchut/learndev/auth/EmailVerificationService.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 41

com/ericbouchut/learndev/auth/LoginAttemptListener.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 33

com/ericbouchut/learndev/auth/PasswordResetController.java

Severity Category Rule Message Line
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@param' should be preceded with an empty line. 32

com/ericbouchut/learndev/auth/PasswordResetMailer.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 21
 Warning javadoc SummaryJavadoc Summary javadoc is missing. 29

com/ericbouchut/learndev/auth/PasswordResetService.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 61
 Warning sizes LineLength Line is longer than 100 characters (found 107). 104

com/ericbouchut/learndev/auth/RegistrationService.java

Severity Category Rule Message Line
 Warning sizes LineLength Line is longer than 100 characters (found 101). 27
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 27
 Warning coding VariableDeclarationUsageDistance Distance between variable 'role' declaration and its first usage is 4, but allowed 3. Consider making that variable final if you still need to store its value in advance (before method calls that might have side effects on the original value). 66
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@param' should be preceded with an empty line. 98

com/ericbouchut/learndev/auth/entity/EmailToken.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4

com/ericbouchut/learndev/auth/entity/PasswordResetToken.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4

com/ericbouchut/learndev/auth/repository/EmailTokenRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 10

com/ericbouchut/learndev/auth/repository/PasswordResetTokenRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 11

com/ericbouchut/learndev/common/config/CacheConfig.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 22

com/ericbouchut/learndev/common/config/SecurityConfig.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 13
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 24
 Warning sizes LineLength Line is longer than 100 characters (found 107). 31
 Warning sizes LineLength Line is longer than 100 characters (found 101). 34

com/ericbouchut/learndev/course/CourseController.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 36

com/ericbouchut/learndev/course/CourseService.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 33

com/ericbouchut/learndev/course/InstructorCourseService.java

Severity Category Rule Message Line
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 30
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 42
 Warning coding VariableDeclarationUsageDistance Distance between variable 'neighborPosition' declaration and its first usage is 5, but allowed 3. Consider making that variable final if you still need to store its value in advance (before method calls that might have side effects on the original value). 221

com/ericbouchut/learndev/course/MarkdownRenderer.java

Severity Category Rule Message Line
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 38
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 43
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 133

com/ericbouchut/learndev/course/entity/Course.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 11

com/ericbouchut/learndev/course/entity/Enrollment.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 15
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 52

com/ericbouchut/learndev/course/entity/EnrollmentStatus.java

Severity Category Rule Message Line
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 6

com/ericbouchut/learndev/course/entity/Lesson.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 3

com/ericbouchut/learndev/course/entity/PublicationStatus.java

Severity Category Rule Message Line
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 6

com/ericbouchut/learndev/course/repository/CourseRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 10

com/ericbouchut/learndev/course/repository/EnrollmentRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 12

com/ericbouchut/learndev/course/repository/LessonRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 10

com/ericbouchut/learndev/legal/LegalController.java

Severity Category Rule Message Line
 Warning javadoc RequireEmptyLineBeforeBlockTagGroup Javadoc tag '@return' should be preceded with an empty line. 17

com/ericbouchut/learndev/role/entity/Role.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 3
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 8

com/ericbouchut/learndev/role/repository/RoleRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 8

com/ericbouchut/learndev/user/entity/User.java

Severity Category Rule Message Line
 Warning imports AvoidStarImport Using the '.*' form of import should be avoided - jakarta.persistence.*. 4
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 14
 Warning javadoc JavadocParagraph <p> tag should be preceded with an empty line. 26

com/ericbouchut/learndev/user/repository/UserRepository.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 10
 Warning whitespace EmptyLineSeparator 'METHOD_DEF' should be separated from previous line. 21
 Warning whitespace EmptyLineSeparator 'METHOD_DEF' should be separated from previous line. 22