Clean up comment issues reported by Maven publish. (linkedin#678)

klarna · Apr 26, 2019 · db59db7 · db59db7
1 parent bc5c923
commit db59db7
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/cruise-control/src/main/java/com/linkedin/kafka/cruisecontrol/analyzer/BalancingAction.java b/cruise-control/src/main/java/com/linkedin/kafka/cruisecontrol/analyzer/BalancingAction.java
@@ -12,7 +12,7 @@
 
 /**
  * Represents the load balancing operation over a replica for Kafka Load GoalOptimizer.
- * Note {@link this#_destinationTp} is only relevant in replica swap operation, for other operations, it will be null.
+ * Note _destinationTp field is only relevant in replica swap operation, for other operations, it will be null.
  */
 public class BalancingAction {
   private static final String TOPIC_PARTITION = "topicPartition";

diff --git a/...-control/src/main/java/com/linkedin/kafka/cruisecontrol/analyzer/BalancingConstraint.java b/...-control/src/main/java/com/linkedin/kafka/cruisecontrol/analyzer/BalancingConstraint.java
@@ -111,7 +111,7 @@ public Double replicaBalancePercentage() {
 
   /**
    * Get topic replica balance percentage for
-   * {@link import com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal}.
+   * {@link com.linkedin.kafka.cruisecontrol.analyzer.goals.TopicReplicaDistributionGoal}.
    */
   public Double topicReplicaBalancePercentage() {
     return _topicReplicaBalancePercentage;

diff --git a/cruise-control/src/main/java/com/linkedin/kafka/cruisecontrol/model/Broker.java b/cruise-control/src/main/java/com/linkedin/kafka/cruisecontrol/model/Broker.java
@@ -108,7 +108,7 @@ public int id() {
    * Get broker capacity for the requested resource.
    *
    * @param resource Resource for which the capacity will be provided.
-   * @return If broker is alive, the capacity of the requested resource, {@link this#DEAD_BROKER_CAPACITY} otherwise.
+   * @return If broker is alive, the capacity of the requested resource, DEAD_BROKER_CAPACITY otherwise.
    */
   public double capacityFor(Resource resource) {
     if (isAlive()) {

diff --git a/...rc/main/java/com/linkedin/kafka/cruisecontrol/servlet/parameters/AddBrokerParameters.java b/...rc/main/java/com/linkedin/kafka/cruisecontrol/servlet/parameters/AddBrokerParameters.java
@@ -11,8 +11,9 @@
 
 /**
  * Parameters for {@link com.linkedin.kafka.cruisecontrol.servlet.EndPoint#ADD_BROKER}
- *
- * <li>Note that "review_id" is mutually exclusive to the other parameters -- i.e. they cannot be used together.</li>
+ *<ul>
+ *   <li>Note that "review_id" is mutually exclusive to the other parameters -- i.e. they cannot be used together.</li>
+ *</ul>
  *
  * <pre>
  *    POST /kafkacruisecontrol/add_broker?brokerid=[id1,id2...]&amp;dryRun=[true/false]

diff --git a/...main/java/com/linkedin/kafka/cruisecontrol/servlet/parameters/RemoveBrokerParameters.java b/...main/java/com/linkedin/kafka/cruisecontrol/servlet/parameters/RemoveBrokerParameters.java
@@ -12,8 +12,9 @@
 
 /**
  * Parameters for {@link com.linkedin.kafka.cruisecontrol.servlet.EndPoint#REMOVE_BROKER}
- *
- * <li>Note that "review_id" is mutually exclusive to the other parameters -- i.e. they cannot be used together.</li>
+ *<ul>
+ *   <li>Note that "review_id" is mutually exclusive to the other parameters -- i.e. they cannot be used together.</li>
+ *</ul>
  *
  * <pre>
  *    POST /kafkacruisecontrol/remove_broker?brokerid=[id1,id2...]&amp;dryRun=[true/false]