Browse Source

YARN-5159. Wrong Javadoc tag in MiniYarnCluster. Contributed by Andras Bokor.

Akira Ajisaka 9 years ago
parent
commit
6cf017558a

+ 13 - 8
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-tests/src/test/java/org/apache/hadoop/yarn/server/MiniYARNCluster.java

@@ -97,16 +97,20 @@ import org.apache.hadoop.yarn.webapp.util.WebAppUtils;
 import com.google.common.annotations.VisibleForTesting;
 
 /**
+ * <p>
  * Embedded Yarn minicluster for testcases that need to interact with a cluster.
- * <p/>
+ * </p>
+ * <p>
  * In a real cluster, resource request matching is done using the hostname, and
  * by default Yarn minicluster works in the exact same way as a real cluster.
- * <p/>
- * If a testcase needs to use multiple nodes and exercise resource request 
+ * </p>
+ * <p>
+ * If a testcase needs to use multiple nodes and exercise resource request
  * matching to a specific node, then the property 
- * {@YarnConfiguration.RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME} should be set
- * <code>true</code> in the configuration used to initialize the minicluster.
- * <p/>
+ * {@value org.apache.hadoop.yarn.conf.YarnConfiguration#RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME}
+ * should be set <code>true</code> in the configuration used to initialize
+ * the minicluster.
+ * </p>
  * With this property set to <code>true</code>, the matching will be done using
  * the <code>hostname:port</code> of the namenodes. In such case, the AM must
  * do resource request using <code>hostname:port</code> as the location.
@@ -736,8 +740,9 @@ public class MiniYARNCluster extends CompositeService {
    * @param timeout Time to wait (sleeps in 10 ms intervals) in milliseconds.
    * @return true if all NodeManagers connect to the (Active)
    * ResourceManager, false otherwise.
-   * @throws YarnException
-   * @throws InterruptedException
+   * @throws YarnException if there is no active RM
+   * @throws InterruptedException if any thread has interrupted
+   * the current thread
    */
   public boolean waitForNodeManagersToConnect(long timeout)
       throws YarnException, InterruptedException {