[
https://issues.apache.org/jira/browse/MATH-1665?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17751314#comment-17751314
]
Alex Herbert commented on MATH-1665:
------------------------------------
The legacy module uses a different checkstyle configuration. All new modules
should fail with missing javadoc (although I did not check) as the checkstyle
is stricter. When updating the checkstyle rules in 2021 (see MATH-1576) I
stopped when I had ticked most of the common issues and there were approx 30K
failures on less significant items. I did not deem it worth my time to fix them.
You could try and update the legacy checkstyle rules to add a check for missing
javadoc; or change the javadoc tool to fail on warnings. Both may lead to more
work that you are able to commit to doing in order to enforce stricter rules.
> 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)
