From ac98dddfe8432bd6610bceea20c6efcbf1f1e423 Mon Sep 17 00:00:00 2001
From: Patrik Nordwall <patrik.nordwall@gmail.com>
Date: Tue, 5 Jun 2012 15:53:30 +0200
Subject: [PATCH] ScalaDoc of awaitClusterUp

---
 .../scala/akka/cluster/MultiNodeClusterSpec.scala     | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/akka-cluster/src/multi-jvm/scala/akka/cluster/MultiNodeClusterSpec.scala b/akka-cluster/src/multi-jvm/scala/akka/cluster/MultiNodeClusterSpec.scala
index 5fe5e7de37..113064e13c 100644
--- a/akka-cluster/src/multi-jvm/scala/akka/cluster/MultiNodeClusterSpec.scala
+++ b/akka-cluster/src/multi-jvm/scala/akka/cluster/MultiNodeClusterSpec.scala
@@ -40,10 +40,21 @@ trait MultiNodeClusterSpec { self: MultiNodeSpec ⇒
    */
   def startClusterNode(): Unit = cluster.self
 
+  /**
+   * Initialize the cluster with the specified member
+   * nodes (roles). First node will be started first
+   * and others will join the first.
+   */
   def startCluster(roles: RoleName*): Unit = {
     awaitStartCluster(false, roles.toSeq)
   }
 
+  /**
+   * Initialize the cluster of the specified member
+   * nodes (roles) and wait until all joined and `Up`.
+   * First node will be started first  and others will join
+   * the first.
+   */
   def awaitClusterUp(roles: RoleName*): Unit = {
     awaitStartCluster(true, roles.toSeq)
   }