Fork me on GitHub
Built by Maven

Checkstyle Results

The following document contains the results of Checkstyle 6.11.2 with build-config/lutece_checks.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
17 0 2 29

Files

File  I  W  E
fr/paris/lutece/plugins/document/modules/rest/rs/DocumentRest.java 0 2 9
fr/paris/lutece/plugins/document/modules/rest/service/formatters/AttributeFormatterXml.java 0 0 4
fr/paris/lutece/plugins/document/modules/rest/service/formatters/DocumentPublicationFormatterXml.java 0 0 3
fr/paris/lutece/plugins/document/modules/rest/service/formatters/SpaceFormatterXml.java 0 0 3
fr/paris/lutece/plugins/document/modules/rest/service/formatters/TypeFormatterXml.java 0 0 3
fr/paris/lutece/plugins/document/modules/rest/service/writers/DocumentPublicationWriter.java 0 0 1
fr/paris/lutece/plugins/document/modules/rest/util/builderxml/AddHeaderXml.java 0 0 3
fr/paris/lutece/plugins/document/modules/rest/util/builderxml/FieldsToCreateDocumentBuilderXml.java 0 0 1
fr/paris/lutece/plugins/document/modules/rest/util/builderxml/ResponseActionBuilderXml.java 0 0 1
fr/paris/lutece/plugins/document/modules/rest/util/constants/DocumentRestConstants.java 0 0 1

Rules

Category Rule Violations Severity
coding ReturnCount
  • max: "5"
 2  Warning
design FinalClass 1  Error
HideUtilityClassConstructor 3  Error
header Header
  • fileExtensions: "java"
  • headerFile: "/opt/data/jenkins/home/jobs/cms-module-document-rest-doc-QA/workspace/target/checkstyle-header.txt"
 2  Error
imports UnusedImports 1  Error
javadoc JavadocMethod 22  Error

Details

fr/paris/lutece/plugins/document/modules/rest/rs/DocumentRest.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Expected an @return tag. 315
 Error javadoc JavadocMethod Expected an @return tag. 351
 Error javadoc JavadocMethod Expected @param tag for 'strIdDocument'. 402
 Error javadoc JavadocMethod Missing a Javadoc comment. 746
 Warning coding ReturnCount Return count is 9 (max allowed is 5). 813
 Error javadoc JavadocMethod Expected @param tag for 'locale'. 813
 Error javadoc JavadocMethod Unused @param tag for 'mRequest'. 939
 Error javadoc JavadocMethod Expected @param tag for 'multipartRequest'. 943
 Error javadoc JavadocMethod Expected @param tag for 'locale'. 943
 Error javadoc JavadocMethod Missing a Javadoc comment. 1063
 Warning coding ReturnCount Return count is 7 (max allowed is 5). 1063

fr/paris/lutece/plugins/document/modules/rest/service/formatters/AttributeFormatterXml.java

Severity Category Rule Message Line
 Error imports UnusedImports Unused import - org.apache.commons.lang.StringUtils. 42
 Error javadoc JavadocMethod Unused @param tag for 'referenceItem'. 72
 Error javadoc JavadocMethod Expected an @return tag. 75
 Error javadoc JavadocMethod Invalid use of the {@inheritDoc} tag. 96

fr/paris/lutece/plugins/document/modules/rest/service/formatters/DocumentPublicationFormatterXml.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of '/*'. 1
 Error javadoc JavadocMethod Unused @param tag for 'doc'. 63
 Error javadoc JavadocMethod Expected @param tag for 'documentPublication'. 66

fr/paris/lutece/plugins/document/modules/rest/service/formatters/SpaceFormatterXml.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Unused @param tag for 'referenceItem'. 72
 Error javadoc JavadocMethod Expected an @return tag. 75
 Error javadoc JavadocMethod Invalid use of the {@inheritDoc} tag. 96

fr/paris/lutece/plugins/document/modules/rest/service/formatters/TypeFormatterXml.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Unused @param tag for 'referenceItem'. 72
 Error javadoc JavadocMethod Expected an @return tag. 75
 Error javadoc JavadocMethod Invalid use of the {@inheritDoc} tag. 96

fr/paris/lutece/plugins/document/modules/rest/service/writers/DocumentPublicationWriter.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of '/*'. 1

fr/paris/lutece/plugins/document/modules/rest/util/builderxml/AddHeaderXml.java

Severity Category Rule Message Line
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 46
 Error javadoc JavadocMethod Expected an @return tag. 60
 Error javadoc JavadocMethod Expected @param tag for 'strXml'. 60

fr/paris/lutece/plugins/document/modules/rest/util/builderxml/FieldsToCreateDocumentBuilderXml.java

Severity Category Rule Message Line
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 56

fr/paris/lutece/plugins/document/modules/rest/util/builderxml/ResponseActionBuilderXml.java

Severity Category Rule Message Line
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 45

fr/paris/lutece/plugins/document/modules/rest/util/constants/DocumentRestConstants.java

Severity Category Rule Message Line
 Error design FinalClass Class DocumentRestConstants should be declared as final. 41