[
https://issues.apache.org/jira/browse/MATH-1665?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17751321#comment-17751321
]
Gilles Sadowski commented on MATH-1665:
---------------------------------------
Yes, I remember about CheckStyle having been made more lenient.
But I'm actually referring to this property:
{noformat}
<failOnWarnings>true</failOnWarnings>
{noformat}
of the "maven-javadoc-plugin". On current "master" the build passes with this
setting, but will fail on subsequent changes that feature incomplete Javadoc:
{noformat}
6 warnings
[WARNING] Javadoc Warnings
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:79:
warning: no description for @param
[WARNING] * @param x
[WARNING] ^
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:124:
warning: no description for @param
[WARNING] * @param factor
[WARNING] ^
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:125:
warning: no description for @param
[WARNING] * @param src
[WARNING] ^
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:142:
warning: no description for @param
[WARNING] * @param factor
[WARNING] ^
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:143:
warning: no description for @param
[WARNING] * @param src
[WARNING] ^
[WARNING]
/home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java:156:
warning: no description for @param
[WARNING] * @param vector
[WARNING] ^
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Apache Commons Math 4.0-SNAPSHOT:
[INFO]
[INFO] Apache Commons Math ................................ SUCCESS [ 5.543 s]
[INFO] Miscellaneous core classes ......................... SUCCESS [ 12.863 s]
[INFO] Artificial neural networks ......................... SUCCESS [ 6.210 s]
[INFO] Transforms ......................................... SUCCESS [ 5.113 s]
[INFO] Exception classes (Legacy) ......................... SUCCESS [ 5.121 s]
[INFO] Miscellaneous core classes (Legacy) ................ FAILURE [ 14.014 s]
[INFO] Apache Commons Math (Legacy) ....................... SKIPPED
[INFO] Apache Commons Math Documentation .................. SKIPPED
[INFO] Example applications ............................... SKIPPED
[INFO] SOFM ............................................... SKIPPED
[INFO] SOFM: Chinese Rings ................................ SKIPPED
[INFO] SOFM: Traveling Salesman Problem ................... SKIPPED
[INFO] K-Means ............................................ SKIPPED
[INFO] K-Means: Image Clustering .......................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
{noformat}
> Shouldn't the build fail on missing Javadoc?
> --------------------------------------------
>
> Key: MATH-1665
> URL: https://issues.apache.org/jira/browse/MATH-1665
> Project: Commons Math
> Issue Type: Task
> Components: legacy, legacy-core
> Reporter: Gilles Sadowski
> Priority: Minor
>
> Running maven (default goal) results in a successful build, even though some
> Javadoc is (partly) missing; e.g.
> {code}
> /**
> * @param lineSearcher
> */
> protected void setLineSearcher(LineSearch lineSearcher) {
> this.lineSearcher = lineSearcher;
> }
> {code}
> results in
> {noformat}
> [WARNING] * @param lineSearcher
> [WARNING] ^
> [WARNING]
> /home/gilles/gilles/devel/java/apache/commons-math/trunk/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/optim/nonlinear/scalar/gradient/GradientLikeOptimizer.java:209:
> warning: no description for @param
> {noformat}
> whereas, according to our "full documentation" requirement, the build should
> fail.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
