Fix javadoc

4 files changed, 24 insertions, 20 deletions

diff --git a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/maintenance/NodeRetirer.java b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/maintenance/NodeRetirer.java
index 541addb247d..96e4c8e31e7 100644
--- a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/maintenance/NodeRetirer.java
+++ b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/maintenance/NodeRetirer.java
@@ -24,6 +24,9 @@ import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 /**
+ * Automatically retires ready and active nodes if they meet a certain criteria given by the {@link RetirementPolicy}
+ * and if there are enough remaining nodes to both replace the retiring node as well as to keep enough in spare.
+ *
  * @author freva
  */
 public class NodeRetirer extends Maintainer {
diff --git a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareChecker.java b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareChecker.java
index b9556836fee..c4692e01cc9 100644
--- a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareChecker.java
+++ b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareChecker.java
@@ -57,13 +57,15 @@ public class FlavorSpareChecker {
     /**
      * Returns a set of possible new flavors that can replace this flavor given current node allocation.
      * If the set is empty, there are not enough spare nodes to safely retire this flavor.
-     *
+     * <p>
      * The algorithm is:
-     *  for all possible wanted flavor, check:
-     *      1: Sum of spare nodes of flavor f and all replacee flavors of f is > 0
-     *      2a: Number of ready nodes of flavor f is > 0
-     *      2b: Verify 1 & 2a for all immediate replacee of f, f_i, where sum of ready nodes of f_i and all
-     *          replacee flavors of f_i is > 0
+     * for all possible wanted flavor, check:
+     * <ul>
+     *   <li>1: Sum of spare nodes of flavor f and all replacee flavors of f is &gt; 0</li>
+     *   <li>2a: Number of ready nodes of flavor f is &gt; 0</li>
+     *   <li>2b: Verify 1 &amp; 2a for all immediate replacee of f, f_i, where sum of ready nodes of f_i and all
+     *       replacee flavors of f_i is &gt; 0</li>
+ *     </ul>
      * Only 2a OR 2b need to be satisfied.
      */
     private Set<FlavorSpareCount> findPossibleReplacementFlavorFor(FlavorSpareCount flavorSpareCount) {
@@ -86,7 +88,7 @@ public class FlavorSpareChecker {
         if (flavorSpareCount.hasReady()) {
             possibleNewFlavors.add(flavorSpareCount);
 
-            // Condition 2b
+        // Condition 2b
         } else {
             for (FlavorSpareCount possibleNewFlavor : flavorSpareCount.getImmediateReplacees()) {
                 if (possibleNewFlavor.getSumOfReadyAmongReplacees() == 0) continue;
diff --git a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCount.java b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCount.java
index 9e8302675ee..2acb7adb804 100644
--- a/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCount.java
+++ b/node-repository/src/main/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCount.java
@@ -12,7 +12,7 @@ import java.util.Set;
 import java.util.stream.Collectors;
 
 /**
- * Keeps track of number of ready & active nodes for a flavor and its replaces neighbors
+ * Keeps track of number of ready and active nodes for a flavor and its replaces neighbors
  *
  * @author freva
  */
diff --git a/node-repository/src/test/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCheckerTest.java b/node-repository/src/test/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCheckerTest.java
index 8418d3e6d47..f41f2983cd4 100644
--- a/node-repository/src/test/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCheckerTest.java
+++ b/node-repository/src/test/java/com/yahoo/vespa/hosted/provision/provisioning/FlavorSpareCheckerTest.java
@@ -25,18 +25,17 @@ import static org.mockito.Mockito.when;
  * @author freva
  */
 public class FlavorSpareCheckerTest {
-    /* Creates flavors where 'replaces' graph that looks like this (largest flavor at the bottom), in
-     * parenthesis is the number of spare nodes for that flavor:
-     * (1) 5
-     *     |
-     *     |
-     * (2) 3      4 (5)           8 (3)
-     *      \   /  \              |
-     *       \ /    \             |
-     *    (2) 1      6 (0)        7 (0)
-     *       / \
-     *      /   \
-     * (3) 0     2 (1)
+    /* Creates flavors where 'replaces' graph that looks like this (largest flavor at the bottom):
+     *   5
+     *   |
+     *   |
+     *   3      4             8
+     *    \   /  \            |
+     *     \ /    \           |
+     *      1      6          7
+     *     / \
+     *    /   \
+     *   0     2
      */
     private static final List<Flavor> flavors = FlavorSpareCountTest.makeFlavors(
             Collections.singletonList(1),   // 0 -> {1}