Add more javadoc for utilization classes

2 files changed, 8 insertions, 4 deletions

diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/ClusterCost.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/ClusterCost.java
index 03d0cd28ca1..b337f85bd6c 100644
--- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/ClusterCost.java
+++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/ClusterCost.java
@@ -6,13 +6,14 @@ package com.yahoo.vespa.hosted.controller.application;
  * tco and waste for one cluster of one deployment.
  *
  * The target utilization is defined the following assumptions:
- * 1. CPU contention starts to cause problems on 0.8
- * 2. Memory management starts to casue problems on 0.7
+ * 1. CPU contention starts to cause problems at 0.8
+ * 2. Memory management starts to cause problems at 0.7
  * 3. Load is evenly divided between two deployments - each deployments can handle the other.
  * 4. Memory and disk are agnostic to query load.
  * 5. Peak utilization (daily variations) are twice the size of the average.
  *
  * With this in mind we get:
+ *
  * CPU: 0.8/2/2 = 0.2
  * Mem: 0.7
  * Disk: 0.7
@@ -44,12 +45,12 @@ public class ClusterCost {
         this.waste  = clusterInfo.getCost() - tco;
     }
 
-    /** @return TCO in dollars */
+    /** @return The TCO in dollars for this cluster (node tco * nodes) */
     public double getTco() {
         return tco;
     }
 
-    /** @return Waste in dollars */
+    /** @return The amount of dollars spent for unused resources in this cluster */
     public double getWaste() {
         return waste;
     }
diff --git a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/DeploymentCost.java b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/DeploymentCost.java
index fce825bd99e..8119a5579f2 100644
--- a/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/DeploymentCost.java
+++ b/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/DeploymentCost.java
@@ -40,14 +40,17 @@ public class DeploymentCost {
         return clusters;
     }
 
+    /** @return Total cost of ownership for the deployment (sum of all clusters) */
     public double getTco() {
         return tco;
     }
 
+    /** @return The most utilized resource utilization */
     public double getUtilization() {
         return utilization;
     }
 
+    /** @return The amount of dollars spend and not utilized */
     public double getWaste() {
         return waste;
     }