Fixed javadoc formatting in LogicalPlanOptimizer.java LogicalValues.j…

…ava OperatorUtils.java Planner.java

Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>

core/src/main/java/org/opensearch/sql/planner/Planner.java

@@ -22,8 +22,8 @@ public class Planner {
 
   /**
    * Generate optimal physical plan for logical plan. If no table involved, translate logical plan
-   * to physical by default implementor. TODO: for now just delegate entire logical plan to storage
-   * engine.
+   * to physical by default implementor.<br>
+   * TODO: for now just delegate entire logical plan to storage engine.
    *
    * @param plan logical plan
    * @return optimal physical plan

core/src/main/java/org/opensearch/sql/planner/logical/LogicalValues.java

@@ -13,17 +13,20 @@
 import org.opensearch.sql.expression.LiteralExpression;
 
 /**
- * Logical operator which is a sequence of literal rows (like a relation). Basically, Values
- * operator is used to create rows of constant literals "out of nothing" which is corresponding with
- * VALUES clause in SQL. Mostly all rows must have the same number of literals and each column
- * should have same type or can be converted implicitly. In particular, typical use cases include:
- * 1. Project without relation involved. 2. Defining query or insertion without a relation. Take the
+ * Logical operator which is a sequence of literal rows (like a relation).<br>
+ * Basically, Values operator is used to create rows of constant literals<br>
+ * "out of nothing" which is corresponding with VALUES clause in SQL. <br>
+ * Mostly all rows must have the same number of literals and each column should
+ * have same type or can be converted implicitly. In particular, typical use cases include:
+ * <ol>
+ * <li>Project without relation involved.</li>
+ * <li>Defining query or insertion without a relation.</li>
+ * </ol>
+ * Take the
  * following logical plan for example:
  *
- * <pre>
- *  LogicalProject(expr=[log(2),true,1+2])
- *   |_ LogicalValues([[]])  #an empty row so that Project can evaluate its expressions in next()
- *  </pre>
+ *  LogicalProject(expr=[log(2),true,1+2])<br>
+ *  &ensp; |_ LogicalValues([[]])  #an empty row so that Project can evaluate its expressions in next()
  */
 @ToString
 @Getter

core/src/main/java/org/opensearch/sql/planner/optimizer/LogicalPlanOptimizer.java

@@ -19,9 +19,13 @@
 import org.opensearch.sql.planner.optimizer.rule.write.CreateTableWriteBuilder;
 
 /**
- * {@link LogicalPlan} Optimizer. The Optimizer will run in the TopDown manner. 1> Optimize the
- * current node with all the rules. 2> Optimize the all the child nodes with all the rules. 3) In
- * case the child node could change, Optimize the current node again.
+ * {@link LogicalPlan} Optimizer.<br>
+ * The Optimizer will run in the TopDown manner.<br>
+ * <ol>
+ *     <li>Optimize the current node with all the rules.</li>
+ *     <li>Optimize the all the child nodes with all the rules.</li>
+ *     <li>In case the child node could change, Optimize the current node again.</li>
+ * </ol>
  */
 public class LogicalPlanOptimizer {
 

core/src/main/java/org/opensearch/sql/utils/OperatorUtils.java

@@ -14,8 +14,9 @@
 @UtilityClass
 public class OperatorUtils {
   /**
-   * Wildcard pattern matcher util. Percent (%) character for wildcard, Underscore (_) character for
-   * a single character match.
+   * Wildcard pattern matcher util.<br>
+   * Percent (%) character for wildcard,<br>
+   * Underscore (_) character for a single character match.
    *
    * @param pattern string pattern to match.
    * @return if text matches pattern returns true; else return false.