YARN-1596. Fixed Javadoc warnings on branch YARN-321. Contributed by Vinod Kumar Vavilapalli.

svn merge --ignore-ancestry -c 1557957 ../YARN-321


git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/branches/branch-2@1562215 13f79535-47bb-0310-9956-ffa450edef68

hadoop-yarn-project/CHANGES.txt

@@ -78,6 +78,9 @@ Branch YARN-321: Generic ApplicationHistoryService
   YARN-1594. Updated pom.xml of applicationhistoryservice sub-project according to
   YARN-888. (Vinod Kumar Vavilapalli via zjshen)
 
+  YARN-1596. Fixed Javadoc warnings on branch YARN-321. (Vinod Kumar Vavilapalli
+  via zjshen)
+
 Release 2.4.0 - UNRELEASED
 
   INCOMPATIBLE CHANGES

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptReportResponse.java

@@ -60,7 +60,7 @@ public abstract class GetApplicationAttemptReportResponse {
   /**
    * Get the <code>ApplicationAttemptReport</code> for the application attempt.
    *
-   * @param ApplicationAttemptReport <code>ApplicationAttemptReport</code> for
+   * @param applicationAttemptReport <code>ApplicationAttemptReport</code> for
    * the application attempt
    */
   @Public

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetApplicationAttemptsRequest.java

@@ -56,7 +56,7 @@ public abstract class GetApplicationAttemptsRequest {
   /**
    * Set the <code>ApplicationId</code> of an application
    *
-   * @param ApplicationId <code>ApplicationId</code> of an application
+   * @param applicationId <code>ApplicationId</code> of an application
    */
   @Public
   @Unstable

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerReportRequest.java

@@ -52,7 +52,7 @@ public abstract class GetContainerReportRequest {
   /**
    * Set the <code>ContainerId</code> of the container
    * 
-   * @param ContainerId
+   * @param containerId
    *          <code>ContainerId</code> of the container
    */
   @Public

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/AHSClient.java

@@ -126,7 +126,7 @@ public abstract class AHSClient extends AbstractService {
    * @throws IOException
    */
   public abstract ApplicationAttemptReport getApplicationAttemptReport(
-      ApplicationAttemptId appAttemptId) throws YarnException, IOException;
+      ApplicationAttemptId applicationAttemptId) throws YarnException, IOException;
 
   /**
    * <p>
@@ -140,7 +140,7 @@ public abstract class AHSClient extends AbstractService {
    * @throws IOException
    */
   public abstract List<ApplicationAttemptReport> getApplicationAttempts(
-      ApplicationId appId) throws YarnException, IOException;
+      ApplicationId applicationId) throws YarnException, IOException;
 
   /**
    * <p>

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/api/YarnClient.java

@@ -386,7 +386,7 @@ public abstract class YarnClient extends AbstractService {
    * @throws IOException
    */
   public abstract ApplicationAttemptReport getApplicationAttemptReport(
-      ApplicationAttemptId appAttemptId) throws YarnException, IOException;
+      ApplicationAttemptId applicationAttemptId) throws YarnException, IOException;
 
   /**
    * <p>
@@ -400,7 +400,7 @@ public abstract class YarnClient extends AbstractService {
    * @throws IOException
    */
   public abstract List<ApplicationAttemptReport> getApplicationAttempts(
-      ApplicationId appId) throws YarnException, IOException;
+      ApplicationId applicationId) throws YarnException, IOException;
 
   /**
    * <p>

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryReader.java

@@ -37,17 +37,18 @@ public interface ApplicationHistoryReader {
   /**
    * This method returns Application {@link ApplicationHistoryData} for the
    * specified {@link ApplicationId}.
+   * @param appId 
    * 
    * @return {@link ApplicationHistoryData} for the ApplicationId.
-   * @throws {@link IOException}
+   * @throws IOException
    */
   ApplicationHistoryData getApplication(ApplicationId appId) throws IOException;
 
   /**
    * This method returns all Application {@link ApplicationHistoryData}s
    * 
-   * @return map {@link ApplicationId, @link ApplicationHistoryData}s.
-   * @throws {@link IOException}
+   * @return map of {@link ApplicationId} to {@link ApplicationHistoryData}s.
+   * @throws IOException
    */
   Map<ApplicationId, ApplicationHistoryData> getAllApplications()
       throws IOException;
@@ -56,9 +57,10 @@ public interface ApplicationHistoryReader {
    * Application can have multiple application attempts
    * {@link ApplicationAttemptHistoryData}. This method returns the all
    * {@link ApplicationAttemptHistoryData}s for the Application.
+   * @param appId 
    * 
    * @return all {@link ApplicationAttemptHistoryData}s for the Application.
-   * @throws {@link IOException}
+   * @throws IOException
    */
   Map<ApplicationAttemptId, ApplicationAttemptHistoryData> getApplicationAttempts(
       ApplicationId appId) throws IOException;
@@ -67,9 +69,9 @@ public interface ApplicationHistoryReader {
    * This method returns {@link ApplicationAttemptHistoryData} for specified
    * {@link ApplicationId}.
    * 
-   * @param {@link ApplicationAttemptId}
+   * @param appAttemptId {@link ApplicationAttemptId}
    * @return {@link ApplicationAttemptHistoryData} for ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   ApplicationAttemptHistoryData getApplicationAttempt(
       ApplicationAttemptId appAttemptId) throws IOException;
@@ -78,9 +80,9 @@ public interface ApplicationHistoryReader {
    * This method returns {@link ContainerHistoryData} for specified
    * {@link ContainerId}.
    * 
-   * @param {@link ContainerId}
+   * @param containerId {@link ContainerId}
    * @return {@link ContainerHistoryData} for ContainerId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   ContainerHistoryData getContainer(ContainerId containerId) throws IOException;
 
@@ -88,21 +90,22 @@ public interface ApplicationHistoryReader {
    * This method returns {@link ContainerHistoryData} for specified
    * {@link ApplicationAttemptId}.
    * 
-   * @param {@link ApplicationAttemptId}
+   * @param appAttemptId {@link ApplicationAttemptId}
    * @return {@link ContainerHistoryData} for ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   ContainerHistoryData getAMContainer(ApplicationAttemptId appAttemptId)
       throws IOException;
   
   /**
-   * This method returns Map{@link ContainerId,@link ContainerHistoryData} for
-   * specified {@link ApplicationAttemptId}.
+   * This method returns Map{@link ContainerId} to {@link ContainerHistoryData}
+   * for specified {@link ApplicationAttemptId}.
    * 
-   * @param {@link ApplicationAttemptId}
-   * @return Map{@link ContainerId, @link ContainerHistoryData} for
+   * @param appAttemptId
+   *          {@link ApplicationAttemptId}
+   * @return Map{@link ContainerId} to {@link ContainerHistoryData} for
    *         ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   Map<ContainerId, ContainerHistoryData> getContainers(
       ApplicationAttemptId appAttemptId) throws IOException;

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-applicationhistoryservice/src/main/java/org/apache/hadoop/yarn/server/applicationhistoryservice/ApplicationHistoryWriter.java

@@ -31,8 +31,9 @@ import org.apache.hadoop.yarn.server.applicationhistoryservice.records.Container
 
 /**
  * It is the interface of writing the application history, exposing the methods
- * of writing {@link ApplicationHistoryData},
- * {@link ApplicationAttemptHistoryData} and {@link ContainerHistoryData}.
+ * of writing {@link ApplicationStartData}, {@link ApplicationFinishData}
+ * {@link ApplicationAttemptStartData}, {@link ApplicationAttemptFinishData},
+ * {@link ContainerStartData} and {@link ContainerFinishData}.
  */
 @Private
 @Unstable

hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/ApplicationContext.java

@@ -36,9 +36,10 @@ public interface ApplicationContext {
   /**
    * This method returns Application {@link ApplicationReport} for the specified
    * {@link ApplicationId}.
+   * @param appId 
    * 
    * @return {@link ApplicationReport} for the ApplicationId.
-   * @throws {@link IOException}
+   * @throws IOException 
    */
   @Public
   @Unstable
@@ -47,8 +48,8 @@ public interface ApplicationContext {
   /**
    * This method returns all Application {@link ApplicationReport}s
    * 
-   * @return map {@link ApplicationId, @link ApplicationReport}s.
-   * @throws {@link IOException}
+   * @return map of {@link ApplicationId} to {@link ApplicationReport}s.
+   * @throws IOException
    */
   @Public
   @Unstable
@@ -58,9 +59,10 @@ public interface ApplicationContext {
    * Application can have multiple application attempts
    * {@link ApplicationAttemptReport}. This method returns the all
    * {@link ApplicationAttemptReport}s for the Application.
+   * @param appId 
    * 
    * @return all {@link ApplicationAttemptReport}s for the Application.
-   * @throws {@link IOException}
+   * @throws IOException
    */
   @Public
   @Unstable
@@ -71,9 +73,9 @@ public interface ApplicationContext {
    * This method returns {@link ApplicationAttemptReport} for specified
    * {@link ApplicationId}.
    * 
-   * @param {@link ApplicationAttemptId}
+   * @param appAttemptId {@link ApplicationAttemptId}
    * @return {@link ApplicationAttemptReport} for ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   @Public
   @Unstable
@@ -84,9 +86,9 @@ public interface ApplicationContext {
    * This method returns {@link ContainerReport} for specified
    * {@link ContainerId}.
    * 
-   * @param {@link ContainerId}
+   * @param containerId {@link ContainerId}
    * @return {@link ContainerReport} for ContainerId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   @Public
   @Unstable
@@ -96,9 +98,9 @@ public interface ApplicationContext {
    * This method returns {@link ContainerReport} for specified
    * {@link ApplicationAttemptId}.
    * 
-   * @param {@link ApplicationAttemptId}
+   * @param appAttemptId {@link ApplicationAttemptId}
    * @return {@link ContainerReport} for ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   @Public
   @Unstable
@@ -106,13 +108,14 @@ public interface ApplicationContext {
       throws IOException;
 
   /**
-   * This method returns Map{@link ContainerId,@link ContainerReport} for
-   * specified {@link ApplicationAttemptId}.
+   * This method returns Map of {@link ContainerId} to {@link ContainerReport}
+   * for specified {@link ApplicationAttemptId}.
    * 
-   * @param {@link ApplicationAttemptId}
-   * @return Map{@link ContainerId, @link ContainerReport} for
+   * @param appAttemptId
+   *          {@link ApplicationAttemptId}
+   * @return Map of {@link ContainerId} to {@link ContainerReport} for
    *         ApplicationAttemptId
-   * @throws {@link IOException}
+   * @throws IOException
    */
   @Public
   @Unstable