You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@mahout.apache.org by "Andrew Palumbo (Jira)" <ji...@apache.org> on 2020/03/01 07:18:00 UTC
[jira] [Commented] (MAHOUT-2081) Sloppy Java docs must be fixed
[ https://issues.apache.org/jira/browse/MAHOUT-2081?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17048481#comment-17048481 ]
Andrew Palumbo commented on MAHOUT-2081:
----------------------------------------
[palumbo|https://app.slack.com/team/U046S2SAJ] [10:17 PM|https://mahout.slack.com/archives/C0473FE3M/p1582870623030000]
With JDK 8, you are unable to get Javadoc unless your tool meets the standards of doclint. Some of its rules are: no self-closed HTML tags, such as <br /> or <a id="x" />
no unclosed HTML tags, such as <ul> without matching </ul>
no invalid HTML end tags, such as </br>
no invalid HTML attributes, based on doclint's interpretation of W3C HTML 4.01
no duplicate HTML id attribute
no empty HTML href attribute
no incorrectly nested headers, such as class documentation must have <h3>, not <h4>
no invalid HTML tags, such as List<String> (where you forgot to escape using <)
no broken @link references
no broken @param references, they must match the actual parameter name
no broken @throws references, the first word must be a class name
Verified that this is our issue.
Screen Shot 2020-02-28 at 3.09.47 PM.png
!https://files.slack.com/files-tmb/T0473FE3B-FUP2QL69K-3ae32b9419/screen_shot_2020-02-28_at_3.09.47_pm_720.png!
diff --git a/core/pom.xml b/core/pom.xml
index b2fab2bb3..a4d8d79a0 100644
--- a/core/pom.xml
+++ b/core/pom.xml
@@ -200,7 +200,7 @@
<executions>
<execution>
<id>attach-javadocs</id>
- <phase>dont-execute</phase>
+ <phase>initialize</phase>
<goals>
<goal>doc-jar</goal>
</goals>
diff --git a/core/src/main/java/org/apache/mahout/math/als/AlternatingLeastSquaresSolver.java b/core/src/main/java/org/apache/mahout/math/als/AlternatingLeastSquaresSolver.java
index dbe1f8bb1..957f6d741 100644
--- a/core/src/main/java/org/apache/mahout/math/als/AlternatingLeastSquaresSolver.java
+++ b/core/src/main/java/org/apache/mahout/math/als/AlternatingLeastSquaresSolver.java
@@ -17,13 +17,14 @@ package org.apache.mahout.math.als;-import com.google.common.base.Preconditions;
+import com.google.common.base.Preconditions;
import com.google.common.collect.Iterables;
import org.apache.mahout.math.DenseMatrix;
import org.apache.mahout.math.Matrix;
import org.apache.mahout.math.QRDecomposition;
import org.apache.mahout.math.Vector;+
/**
* See
* <a href="">
and it reduced several errors. down to around 16 from many more:
[INFO] Writing to /Users/colleenpalumbo/sandbox/mahout/core/target/generated-test-sources/mahout/org/apache/mahout/math/set/OpenDoubleHashSetTest.java
[INFO]
[INFO] --- build-helper-maven-plugin:3.0.0:add-source (add-source) @ mahout-core_2.11 ---
[INFO] Source directory: /Users/colleenpalumbo/sandbox/mahout/core/target/generated-sources/mahout added.
[INFO]
[INFO] --- build-helper-maven-plugin:3.0.0:add-test-source (add-test-source) @ mahout-core_2.11 ---
[INFO] Test Source directory: /Users/colleenpalumbo/sandbox/mahout/core/target/generated-test-sources/mahout added.
[INFO]
[INFO] --- maven-remote-resources-plugin:1.7.0:process (process-resource-bundles) @ mahout-core_2.11 ---
[INFO] Preparing remote bundle org.apache:apache-jar-resource-bundle:1.4
[INFO] Copying 3 resources from 1 bundle.
[INFO]
[INFO] <<< scala-maven-plugin:4.0.2:doc-jar (attach-javadocs) < generate-resources @ mahout-core_2.11 <<<
[INFO]
[INFO] --- scala-maven-plugin:4.0.2:doc-jar (attach-javadocs) @ mahout-core_2.11 ---
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/math/indexeddataset/BiMap.scala:116: warning: discarding unmoored doc comment
/**
^
warning: there were 69 feature warnings; re-run with -feature for details
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/list/SimpleLongArrayList.java:15: error: not found: type AbstractLongList
public class SimpleLongArrayList extends AbstractLongList {
^
model contains 333 documentable templates
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:441: warning: Could not find any member to link for "UnsupportedOperationException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:433: warning: Could not find any member to link for "UnsupportedOperationException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:426: warning: Could not find any member to link for "UnsupportedOperationException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:395: warning: Could not find any member to link for "UnsupportedOperationException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:292: warning: Could not find any member to link for "IllegalStateException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:311: warning: Could not find any member to link for "IllegalStateException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:200: warning: Could not find any member to link for "IllegalArgumentException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:200: warning: Could not find any member to link for "IllegalStateException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:190: warning: Could not find any member to link for "IllegalArgumentException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:190: warning: Could not find any member to link for "IllegalStateException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/classifier/stats/ClassifierStats.scala:182: warning: Could not find any member to link for "IllegalArgumentException".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/util/IOUtilsScala.scala:53: warning: Could not find any member to link for "IOUtilsScala.close(".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/math/drm/package.scala:234: warning: Could not find any member to link for "dcolMeanCov()".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/scala/org/apache/mahout/math/drm/package.scala:124: warning: Could not find any member to link for "Int".
/**
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/als/ImplicitFeedbackAlternatingLeastSquaresSolver.java:32: error: object OpenIntObjectHashMap is not a member of package org.apache.mahout.math.map
import org.apache.mahout.math.map.OpenIntObjectHashMap;
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/als/ImplicitFeedbackAlternatingLeastSquaresSolver.java:52: error: not found: type OpenIntObjectHashMap
OpenIntObjectHashMap<Vector> Y, int numTrainingThreads) {
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/als/ImplicitFeedbackAlternatingLeastSquaresSolver.java:74: error: not found: type OpenIntObjectHashMap
public Matrix getYtransposeY(final OpenIntObjectHashMap<Vector> Y) {
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/SparseMatrix.java:30: error: object IntArrayList is not a member of package org.apache.mahout.math.list
import org.apache.mahout.math.list.IntArrayList;
^
/Users/colleenpalumbo/sandbox/mahout/core/src/main/java/org/apache/mahout/math/SparseMatrix.java:237: error: not found: type IntArrayList
public IntArrayList nonZeroRowIndices() {
^
many are just broken links in the javadocs tdue to refactored packages, and the revocation of any markdown in the Javadoc standard, which we used to have a bunch of in these templates.
> Sloppy Java docs must be fixed
> ------------------------------
>
> Key: MAHOUT-2081
> URL: https://issues.apache.org/jira/browse/MAHOUT-2081
> Project: Mahout
> Issue Type: Bug
> Affects Versions: 14.1
> Reporter: Trevor Grant
> Priority: Major
> Fix For: 14.1
>
>
> Starting in Java 8 java doc quality is much more strictly enforced.
> Over the years we've been pretty loose with our doc quality.
> At the moment this is commented out, but what we need is someone to go through and fix all the old java doc errors.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)