Enforce the JavadocMethod checkstyle rule

mrigger · mrigger · commit 967359401f63 · 2020-08-13T23:44:44.000+02:00
diff --git a/configs/checkstyle.xml b/configs/checkstyle.xml
@@ -80,7 +80,7 @@
 		<!-- Checks for Javadoc comments. -->
 		<!-- See https://checkstyle.org/config_javadoc.html -->
 		<module name="InvalidJavadocPosition" />
-		<!-- <module name="JavadocMethod"/> -->
+		<module name="JavadocMethod"/>
 		<module name="JavadocType"/>
 		<module name="JavadocStyle"/>
 
diff --git a/src/sqlancer/DatabaseProvider.java b/src/sqlancer/DatabaseProvider.java
@@ -8,11 +8,15 @@ public interface DatabaseProvider<G extends GlobalState<O, ?>, O extends DBMSSpe
 
     /**
      * Gets the the {@link GlobalState} class.
+     *
+     * @return the class extending {@link GlobalState}
      */
     Class<G> getGlobalStateClass();
 
     /**
      * Gets the JCommander option class.
+     *
+     * @return the class representing the DBMS-specific options.
      */
     Class<O> getOptionClass();
 
@@ -29,6 +33,8 @@ public interface DatabaseProvider<G extends GlobalState<O, ?>, O extends DBMSSpe
 
     /**
      * The DBMS name is used to name the log directory and command to test the respective DBMS.
+     *
+     * @return the DBMS' name
      */
     String getDBMSName();
 
diff --git a/src/sqlancer/StateToReproduce.java b/src/sqlancer/StateToReproduce.java
@@ -95,7 +95,7 @@ public long getSeedValue() {
      * Returns a local state in which a test oracle can save useful information about a single run. If the local state
      * is closed without indicating access to it, the local statements will be added to the global state.
      *
-     * @return
+     * @return the local state for logging
      */
     public OracleRunReproductionState getLocalState() {
         return localState;
diff --git a/src/sqlancer/clickhouse/ast/ClickHouseCast.java b/src/sqlancer/clickhouse/ast/ClickHouseCast.java
@@ -109,7 +109,7 @@ public static ClickHouseConstant castToNumericFromNumOperand(ClickHouseConstant
         return convertInternal(value, false, false, false);
     }
 
-    /**
+    /*
      * Applies numeric affinity to a value.
      */
     public static ClickHouseConstant castToNumeric(ClickHouseConstant value) {
diff --git a/src/sqlancer/common/query/Query.java b/src/sqlancer/common/query/Query.java
@@ -11,18 +11,10 @@ public abstract class Query {
     /**
      * Whether the query could affect the schema (i.e., by add/deleting columns or tables).
      *
-     * @return
+     * @return true if the query can affect the database's schema, false otherwise
      */
     public abstract boolean couldAffectSchema();
 
-    /**
-     *
-     * @param con
-     *
-     * @return true if the query was successful, false otherwise
-     *
-     * @throws SQLException
-     */
     public abstract boolean execute(GlobalState<?, ?> globalState, String... fills) throws SQLException;
 
     public abstract ExpectedErrors getExpectedErrors();
diff --git a/src/sqlancer/mysql/ast/MySQLComputableFunction.java b/src/sqlancer/mysql/ast/MySQLComputableFunction.java
@@ -177,6 +177,8 @@ private static MySQLConstant aggregate(MySQLConstant[] evaluatedArgs, BinaryOper
         /**
          * Gets the number of arguments if the function is non-variadic. If the function is variadic, the minimum number
          * of arguments is returned.
+         *
+         * @return the number of arguments
          */
         public int getNrArgs() {
             return nrArgs;
diff --git a/src/sqlancer/mysql/gen/MySQLSetGenerator.java b/src/sqlancer/mysql/gen/MySQLSetGenerator.java
@@ -128,7 +128,7 @@ private enum Action {
             this.scopes = scopes.clone();
         }
 
-        /**
+        /*
          * @see https://dev.mysql.com/doc/refman/8.0/en/switchable-optimizations.html
          */
         private static String getOptimizerSwitchConfiguration(Randomly r) {
diff --git a/src/sqlancer/postgres/ast/PostgresFunction.java b/src/sqlancer/postgres/ast/PostgresFunction.java
@@ -248,6 +248,8 @@ public PostgresDataType[] getType(int nr, PostgresDataType type) {
         /**
          * Gets the number of arguments if the function is non-variadic. If the function is variadic, the minimum number
          * of arguments is returned.
+         *
+         * @return the number of arguments
          */
         public int getNrArgs() {
             return nrArgs;
diff --git a/src/sqlancer/sqlite3/ast/SQLite3Cast.java b/src/sqlancer/sqlite3/ast/SQLite3Cast.java
@@ -114,7 +114,7 @@ public static SQLite3Constant castToNumericFromNumOperand(SQLite3Constant value)
         return convertInternal(value, false, false, false);
     }
 
-    /**
+    /*
      * Applies numeric affinity to a value.
      */
     public static SQLite3Constant castToNumeric(SQLite3Constant value) {
diff --git a/src/sqlancer/sqlite3/ast/SQLite3Function.java b/src/sqlancer/sqlite3/ast/SQLite3Function.java
@@ -275,6 +275,8 @@ public SQLite3Constant apply(SQLite3Constant... args) {
         /**
          * Gets the number of arguments if the function is non-variadic. If the function is variadic, the minimum number
          * of arguments is returned.
+         *
+         * @return the number of arguments
          */
         public int getNrArgs() {
             return nrArgs;
diff --git a/src/sqlancer/sqlite3/gen/SQLite3ExpressionGenerator.java b/src/sqlancer/sqlite3/gen/SQLite3ExpressionGenerator.java
@@ -157,11 +157,8 @@ public boolean omitBracketsWhenPrinting() {
         return expr;
     }
 
-    /**
-     *
-     * @see https://www.sqlite.org/syntax/literal-value.html
-     *
-     * @return
+    /*
+     * https://www.sqlite.org/syntax/literal-value.html
      */
     private SQLite3Expression getRandomLiteralValueInternal(Randomly r) {
         LiteralValueType randomLiteral = Randomly.fromOptions(LiteralValueType.values());
diff --git a/src/sqlancer/sqlite3/gen/ddl/SQLite3IndexGenerator.java b/src/sqlancer/sqlite3/gen/ddl/SQLite3IndexGenerator.java
@@ -106,7 +106,7 @@ private String createIndex(SQLite3Table t, List<SQLite3Column> columns) {
         return sb.toString();
     }
 
-    /**
+    /*
      * Appends ASC, DESC, or nothing.
      */
     private void appendPotentialOrdering(StringBuilder sb) {
diff --git a/src/sqlancer/sqlite3/schema/SQLite3Schema.java b/src/sqlancer/sqlite3/schema/SQLite3Schema.java
@@ -98,6 +98,8 @@ public boolean isOnlyPrimaryKey() {
         /**
          * If a table has a single column primary key and the declared type of that column is "INTEGER" and the table is
          * not a WITHOUT ROWID table, then the column is known as an INTEGER PRIMARY KEY.
+         *
+         * @return whether the column is an INTEGER PRIMARY KEY
          */
         public boolean isIntegerPrimaryKey() {
             return isInteger && isOnlyPrimaryKey() && !getTable().hasWithoutRowid();

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public long getSeedValue() {`
`95`	`95`	`* Returns a local state in which a test oracle can save useful information about a single run. If the local state`
`96`	`96`	`* is closed without indicating access to it, the local statements will be added to the global state.`
`97`	`97`	`*`
`98`		`- * @return`
	`98`	`+ * @return the local state for logging`
`99`	`99`	`*/`
`100`	`100`	`public OracleRunReproductionState getLocalState() {`
`101`	`101`	`return localState;`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public static ClickHouseConstant castToNumericFromNumOperand(ClickHouseConstant`
`109`	`109`	`return convertInternal(value, false, false, false);`
`110`	`110`	`}`
`111`	`111`
`112`		`- /**`
	`112`	`+ /*`
`113`	`113`	`* Applies numeric affinity to a value.`
`114`	`114`	`*/`
`115`	`115`	`public static ClickHouseConstant castToNumeric(ClickHouseConstant value) {`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ private enum Action {`
`128`	`128`	`this.scopes = scopes.clone();`
`129`	`129`	`}`
`130`	`130`
`131`		`- /**`
	`131`	`+ /*`
`132`	`132`	`* @see https://dev.mysql.com/doc/refman/8.0/en/switchable-optimizations.html`
`133`	`133`	`*/`
`134`	`134`	`private static String getOptimizerSwitchConfiguration(Randomly r) {`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public static SQLite3Constant castToNumericFromNumOperand(SQLite3Constant value)`
`114`	`114`	`return convertInternal(value, false, false, false);`
`115`	`115`	`}`
`116`	`116`
`117`		`- /**`
	`117`	`+ /*`
`118`	`118`	`* Applies numeric affinity to a value.`
`119`	`119`	`*/`
`120`	`120`	`public static SQLite3Constant castToNumeric(SQLite3Constant value) {`