Jonathan Hurley created AMBARI-24828:
----------------------------------------
Summary: Correct Javadoc Errors in the SPI
Key: AMBARI-24828
URL: https://issues.apache.org/jira/browse/AMBARI-24828
Project: Ambari
Issue Type: Bug
Components: ambari-server-spi
Affects Versions: 2.8.0
Reporter: Jonathan Hurley
Assignee: Jonathan Hurley
Fix For: 2.8.0
During the preparation for distribution the SPI, the following Javadoc errors
were produced by maven:
{code}
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java:34:
error: reference not found
[ERROR] * to any {@link ClusterCheck} instance.
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java:35:
error: self-closing element not allowed
[ERROR] * <p/>
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java:38:
error: reference not found
[ERROR] * {@link UpgradeCheckRegistry}.
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java:53:
error: self-closing element not allowed
[ERROR] * <p/>
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/annotations/UpgradeCheckInfo.java:65:
error: self-closing element not allowed
[ERROR] * <p/>
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java:33:
warning: no description for @param
[ERROR] * @param request
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java:34:
warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/CheckQualification.java:35:
warning: no description for @throws
[ERROR] * @throws AmbariException
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckDescription.java:91:
warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckGroup.java:23:
error: self-closing element not allowed
[ERROR] * <p/>
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java:44:
error: @param name not found
[ERROR] * @param clusterName
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java:50:
error: @param name not found
[ERROR] * @param configurations
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java:54:
warning: no @param for clusterInformation
[ERROR] public UpgradeCheckRequest(ClusterInformation clusterInformation,
UpgradeType upgradeType,
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckRequest.java:54:
warning: no @param for checkConfigurations
[ERROR] public UpgradeCheckRequest(ClusterInformation clusterInformation,
UpgradeType upgradeType,
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/upgrade/UpgradeCheckResult.java:59:
warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR]
/Users/jhurley/src/apache/ambari/ambari-server-spi/src/main/java/org/apache/ambari/spi/RepositoryVersion.java:52:
warning: no description for @return
[ERROR] * @return
[ERROR] ^
{code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
