Since commons-parent version 41, generation of the clirr report for the site has to be explicitly enabled by adding a "src\site\resources\profile.clirr" file.
This annotation was with "LANG-1316: Deprecate classes/methods moved to commons-text" and removed by mistake while reverting "LANG-1269: Wrong name or result of StringUtils#getJaroWinklerDistance".
This reverts commit a40b2a907a69e51675d7d0502b2608833c4da343, because adding a new method StringUtils#getJaroWinklerSimilarity and immediately deprecating it makes not sense.
* org.apache.commons.lang3.text.translate - every class
* org.apache.commons.lang3.text - every class other than WordUtils
* StringEscapeUtils - whole class
* StringUtils: getLevenshteinDistance, getFuzzyDistance and getJaroWinklerSimilarity methods
* ObjectUtils: identityToString(final StrBuilder builder, final Object object) method (StrBuilder was moved to commons-text)
This patch enforces the code style defined by the checkstyle checks
to the test files too.
In the cases where it would just add robustness and not improve the
code's readability and maintainability (specifically - the javadoc
checks), those checks are explicitly suppressed.
Currently, checkstyle is only run as part of the reporting phase, and
it's up to the developer to check the report manually.
This patch adds the checkstyle configuration to the build plugins so
it can be used to check the code (as opposed to just generate a
report of the failures) and adds it to Travis CI's configuration so
every new patch will be automatically checked against it.
This patch upgrades maven-checkstyle-plugin to the latest available
version, 2.17.
This is done in order to consume a fix for checkstyle wrongfully
reporting an error if the @return javadoc tag was used in an
annotation type, as it is in Guarded (line 36).
Note that checkstyle has removed the RedundantThrows check (see
discussion at https://github.com/checkstyle/checkstyle/issues/473),
so it was removed from the project's checkstyle.xml configuration.
The defacto style of the project requires Javadoc for public methods
only, but the checkstyle Javadoc check defaults to requiring them even
for private methods, generating 46 errors.
This patch sets the checkstyle Javadoc check's scope to public to clean
up the checkstyle report so it can be enabled in the CI.
If we wish to reset the check to a laxer scope, the aforementioned
errors should be fixed first.
