Fix JavaDoc issues

mrigger · mrigger · commit e11882413cd0 · 2021-01-20T23:47:54.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -12,7 +12,7 @@
     <sourceDirectory>src</sourceDirectory>
     <testSourceDirectory>test</testSourceDirectory>
     <plugins>
-      <plugin> 
+      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>3.2.0</version>
diff --git a/src/sqlancer/DatabaseProvider.java b/src/sqlancer/DatabaseProvider.java
@@ -24,6 +24,9 @@ public interface DatabaseProvider<G extends GlobalState<O, ?, C>, O extends DBMS
      * @param globalState
      *            the state created and is valid for this method call.
      *
+     * @throws Exception
+     *             if creating the database fails.
+     *
      */
     void generateAndTestDatabase(G globalState) throws Exception;
 
diff --git a/src/sqlancer/common/oracle/PivotedQuerySynthesisBase.java b/src/sqlancer/common/oracle/PivotedQuerySynthesisBase.java
@@ -61,6 +61,7 @@ public final void check() throws Exception {
      * @return true if at least one row is contained, false otherwise
      *
      * @throws Exception
+     *             if the query unexpectedly fails
      */
     private boolean containsRows(Query<C> query) throws Exception {
         try (SQLancerResultSet result = query.executeAndGet(globalState)) {
@@ -108,6 +109,7 @@ protected void reportMissingPivotRow(Query<?> query) {
      * @return a query that checks whether the pivot row is contained in pivotRowQuery
      *
      * @throws Exception
+     *             if an unexpected error occurs
      */
     protected abstract Query<C> getContainmentCheckQuery(Query<?> pivotRowQuery) throws Exception;
 
@@ -118,6 +120,7 @@ protected void reportMissingPivotRow(Query<?> query) {
      * @return the rectified query
      *
      * @throws Exception
+     *             if an unexpected error occurs
      */
     protected abstract Query<C> getRectifiedQuery() throws Exception;
 
diff --git a/src/sqlancer/mysql/ast/MySQLComputableFunction.java b/src/sqlancer/mysql/ast/MySQLComputableFunction.java
@@ -38,7 +38,8 @@ public enum MySQLFunction {
         // }
         // },
         /**
-         * @see https://dev.mysql.com/doc/refman/8.0/en/bit-functions.html#function_bit-count
+         * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/bit-functions.html#function_bit-count">Bit Functions
+         *      and Operators</a>
          */
         BIT_COUNT(1, "BIT_COUNT") {
 
@@ -92,7 +93,8 @@ public boolean isVariadic() {
 
         },
         /**
-         * @see https://dev.mysql.com/doc/refman/8.0/en/control-flow-functions.html#function_if
+         * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/control-flow-functions.html#function_if">Flow Control
+         *      Functions</a>
          */
         IF(3, "IF") {
 
@@ -113,7 +115,7 @@ public MySQLConstant apply(MySQLConstant[] args, MySQLExpression... origArgs) {
 
         },
         /**
-         * @see https://dev.mysql.com/doc/refman/8.0/en/control-flow-functions.html#function_ifnull
+         * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/control-flow-functions.html#function_ifnull">IFNULL</a>
          */
         IFNULL(2, "IFNULL") {
 
diff --git a/src/sqlancer/mysql/ast/MySQLInOperation.java b/src/sqlancer/mysql/ast/MySQLInOperation.java
@@ -5,7 +5,8 @@
 import sqlancer.IgnoreMeException;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/comparison-operators.html#operator_in
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/comparison-operators.html#operator_in">Comparison Functions and
+ *      Operators</a>
  */
 public class MySQLInOperation implements MySQLExpression {
 
diff --git a/src/sqlancer/mysql/gen/MySQLDropIndex.java b/src/sqlancer/mysql/gen/MySQLDropIndex.java
@@ -8,7 +8,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/drop-index.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/drop-index.html">DROP INDEX Statement</a>
  */
 public final class MySQLDropIndex {
 
diff --git a/src/sqlancer/mysql/gen/tblmaintenance/MySQLAnalyzeTable.java b/src/sqlancer/mysql/gen/tblmaintenance/MySQLAnalyzeTable.java
@@ -10,7 +10,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html">ANALYZE TABLE Statement</a>
  */
 public class MySQLAnalyzeTable {
 
diff --git a/src/sqlancer/mysql/gen/tblmaintenance/MySQLCheckTable.java b/src/sqlancer/mysql/gen/tblmaintenance/MySQLCheckTable.java
@@ -9,7 +9,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/check-table.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/check-table.html">CHECK TABLE Statement</a>
  */
 public class MySQLCheckTable {
 
diff --git a/src/sqlancer/mysql/gen/tblmaintenance/MySQLChecksum.java b/src/sqlancer/mysql/gen/tblmaintenance/MySQLChecksum.java
@@ -9,7 +9,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/checksum-table.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/checksum-table.html">CHECKSUM TABLE Statement</a>
  */
 public class MySQLChecksum {
 
diff --git a/src/sqlancer/mysql/gen/tblmaintenance/MySQLOptimize.java b/src/sqlancer/mysql/gen/tblmaintenance/MySQLOptimize.java
@@ -9,7 +9,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/optimize-table.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/optimize-table.html">OPTIMIZE TABLE Statement</a>
  */
 public class MySQLOptimize {
 
diff --git a/src/sqlancer/mysql/gen/tblmaintenance/MySQLRepair.java b/src/sqlancer/mysql/gen/tblmaintenance/MySQLRepair.java
@@ -10,7 +10,7 @@
 import sqlancer.mysql.MySQLSchema.MySQLTable.MySQLEngine;
 
 /**
- * @see https://dev.mysql.com/doc/refman/8.0/en/repair-table.html
+ * @see <a href="https://dev.mysql.com/doc/refman/8.0/en/repair-table.html">REPAIR TABLE Statement</a>
  */
 public class MySQLRepair {
 
diff --git a/src/sqlancer/postgres/ast/PostgresAggregate.java b/src/sqlancer/postgres/ast/PostgresAggregate.java
@@ -10,7 +10,7 @@
 import sqlancer.postgres.ast.PostgresAggregate.PostgresAggregateFunction;
 
 /**
- * @see https://www.sqlite.org/lang_aggfunc.html
+ * @see <a href="https://www.sqlite.org/lang_aggfunc.html">Built-in Aggregate Functions</a>
  */
 public class PostgresAggregate extends FunctionNode<PostgresAggregateFunction, PostgresExpression>
         implements PostgresExpression {
diff --git a/src/sqlancer/postgres/gen/PostgresCommentGenerator.java b/src/sqlancer/postgres/gen/PostgresCommentGenerator.java
@@ -7,7 +7,7 @@
 import sqlancer.postgres.PostgresSchema.PostgresTable;
 
 /**
- * @see https://www.postgresql.org/docs/devel/sql-comment.html
+ * @see <a href="https://www.postgresql.org/docs/devel/sql-comment.html">COMMENT</a>
  */
 public final class PostgresCommentGenerator {
 
diff --git a/src/sqlancer/sqlite3/ast/SQLite3Aggregate.java b/src/sqlancer/sqlite3/ast/SQLite3Aggregate.java
@@ -11,7 +11,7 @@
 import sqlancer.sqlite3.schema.SQLite3Schema.SQLite3Column.SQLite3CollateSequence;
 
 /**
- * @see https://www.sqlite.org/lang_aggfunc.html
+ * @see <a href="https://www.sqlite.org/lang_aggfunc.html">Built-in Aggregate Functions</a>
  */
 public class SQLite3Aggregate extends SQLite3Expression {
 
diff --git a/src/sqlancer/sqlite3/ast/SQLite3UnaryOperation.java b/src/sqlancer/sqlite3/ast/SQLite3UnaryOperation.java
@@ -36,7 +36,7 @@ public SQLite3CollateSequence getImplicitCollateSequence() {
     /**
      * Supported unary prefix operators are these: -, +, ~, and NOT.
      *
-     * @see https://www.sqlite.org/lang_expr.html
+     * @see <a href="https://www.sqlite.org/lang_expr.html">SQL Language Expressions</a>
      *
      */
     public enum UnaryOperator {
diff --git a/src/sqlancer/sqlite3/gen/SQLite3ReindexGenerator.java b/src/sqlancer/sqlite3/gen/SQLite3ReindexGenerator.java
@@ -7,7 +7,7 @@
 import sqlancer.sqlite3.schema.SQLite3Schema;
 
 /**
- * @see https://www.sqlite.org/lang_reindex.html
+ * @see <a href="https://www.sqlite.org/lang_reindex.html">REINDEX</a>
  */
 public final class SQLite3ReindexGenerator {
 
diff --git a/src/sqlancer/sqlite3/gen/SQLite3VacuumGenerator.java b/src/sqlancer/sqlite3/gen/SQLite3VacuumGenerator.java
@@ -6,7 +6,7 @@
 import sqlancer.sqlite3.SQLite3Provider.SQLite3GlobalState;
 
 /**
- * @see https://www.sqlite.org/lang_vacuum.html
+ * @see <a href="https://www.sqlite.org/lang_vacuum.html">VACUUM</a>
  */
 public final class SQLite3VacuumGenerator {
 

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,9 @@ public interface DatabaseProvider<G extends GlobalState<O, ?, C>, O extends DBMS`
`24`	`24`	`* @param globalState`
`25`	`25`	`* the state created and is valid for this method call.`
`26`	`26`	`*`
	`27`	`+ * @throws Exception`
	`28`	`+ * if creating the database fails.`
	`29`	`+ *`
`27`	`30`	`*/`
`28`	`31`	`void generateAndTestDatabase(G globalState) throws Exception;`
`29`	`32`