Kevin Risden created KNOX-2063:
----------------------------------

             Summary: KnoxShellTable javadoc failures
                 Key: KNOX-2063
                 URL: https://issues.apache.org/jira/browse/KNOX-2063
             Project: Apache Knox
          Issue Type: Bug
          Components: KnoxShell
            Reporter: Kevin Risden
            Assignee: Ljmiv
             Fix For: 1.4.0


[~ljmiv] the recent changes for KnoxShellTable caused a bunch of Javadoc 
errors/warnings.

Here is a way to run just the javadoc to confirm fixes:

{code:java}
mvn -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=true 
-DskipTests=true -Dcheckstyle.skip=true -Dspotbugs.skip=true -Dmdep.skip=true 
-Djacoco.skip=true javadoc:javadoc javadoc:test-javadoc
{code}

Here is an example of the output:

{code:java}
10:58:32 [ERROR] Failed to execute goal 
org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:javadoc (default-cli) on 
project gateway-shell: An error has occurred in Javadoc report generation: 
10:58:32 [ERROR] Exit code: 1 - 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:159:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:168:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:168:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:171:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double mean(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:177:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:186:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:186:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:189:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double median(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:195:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:204:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:204:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:207:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double mode(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:213:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:222:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:222:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:225:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double sum(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:231:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:240:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:240:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:243:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double max(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:249:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:258:
 error: @param name not found
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]             ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:258:
 warning: no description for @param
10:58:32 [ERROR]    * @param colName
10:58:32 [ERROR]      ^
10:58:32 [ERROR] 
/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/src/main/java/org/apache/knox/gateway/shell/table/KnoxShellTable.java:261:
 warning: no @param for colIndex
10:58:32 [ERROR]   public double min(int colIndex) {
10:58:32 [ERROR]                 ^
10:58:32 [ERROR] 
10:58:32 [ERROR] Command line was: 
/home/jenkins/agent/tools/hudson.model.JDK/jdk8/jdk8u212-b03/jre/../bin/javadoc 
@options @packages
10:58:32 [ERROR] 
10:58:32 [ERROR] Refer to the generated Javadoc files in 
'/home/jenkins/agent/workspace/apache/knox-master-javadoc/gateway-shell/target/site/apidocs'
 dir.
10:58:32 [ERROR] 
10:58:32 [ERROR] -> [Help 1]
10:58:32 [ERROR] 
10:58:32 [ERROR] To see the full stack trace of the errors, re-run Maven with 
the -e switch.
10:58:32 [ERROR] Re-run Maven using the -X switch to enable full debug logging.
10:58:32 [ERROR] 
10:58:32 [ERROR] For more information about the errors and possible solutions, 
please read the following articles:
10:58:32 [ERROR] [Help 1] 
http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
10:58:32 [ERROR] 
10:58:32 [ERROR] After correcting the problems, you can resume the build with 
the command
10:58:32 [ERROR]   mvn <goals> -rf :gateway-shell
{code}




--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to