changeset 867:5a59910e8f87

Resolve some javadoc errors and warnings
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 01 Feb 2024 18:55:11 +0100 (14 months ago)
parents 6d229896c785
children a227deba0e26
files src/main/java/org/monetdb/jdbc/MonetConnection.java src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java src/main/java/org/monetdb/mcl/net/MapiSocket.java src/main/java/org/monetdb/mcl/net/Parameter.java src/main/java/org/monetdb/mcl/net/ParameterType.java
diffstat 6 files changed, 14 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/src/main/java/org/monetdb/jdbc/MonetConnection.java
+++ b/src/main/java/org/monetdb/jdbc/MonetConnection.java
@@ -1516,8 +1516,8 @@ public class MonetConnection
 	/**
 	 * Construct a Properties object holding all connection parameters such
 	 * as host, port, TLS configuration, autocommit, etc.
-	 * Passing this to {@link DriverManager.getConnection()} together
-	 * with the URL "jdbc:monetdb:" will create a new connection identical to
+	 * Passing this to {@link java.sql.DriverManager#getConnection(String,java.util.Properties)}
+	 * together with the URL "jdbc:monetdb:" will create a new connection identical to
 	 * the current one.
 	 *
 	 * @return a Properties object
--- a/src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java
+++ b/src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java
@@ -769,7 +769,7 @@ public class MonetPreparedStatement
 		setValue(parameterIndex, Byte.toString(x));
 	}
 
-	static final char[] HEXES = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
+	private static final char[] HEXES = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
 	/**
 	 * Sets the designated parameter to the given Java array of bytes. The
 	 * driver converts this to an SQL VARBINARY or LONGVARBINARY (depending
--- a/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
+++ b/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
@@ -101,6 +101,7 @@ public final class BufferedMCLReader {
 	/**
 	 * Return a substring of the current line, or null if we're at the end or before the beginning.
 	 *
+	 * @param start beginIndex
 	 * @return the current line or null
 	 */
 	public String getLine(int start) {
--- a/src/main/java/org/monetdb/mcl/net/MapiSocket.java
+++ b/src/main/java/org/monetdb/mcl/net/MapiSocket.java
@@ -81,7 +81,7 @@ import org.monetdb.mcl.parser.MCLParseEx
  * geared towards the format of the data.
  *
  * @author Fabian Groffen
- * @version 4.3
+ * @version 4.4
  * @see org.monetdb.mcl.io.BufferedMCLReader
  * @see org.monetdb.mcl.io.BufferedMCLWriter
  */
@@ -771,6 +771,7 @@ public final class MapiSocket {
 		return target.isDebug();
 	}
 
+
 	/**
 	 * Inner class that is used to write data on a normal stream as a
 	 * blocked stream.  A call to the flush() method will write a
@@ -1552,8 +1553,8 @@ public final class MapiSocket {
 
 		/**
 		 * Pass option=value during the handshake
-		 * @param field
-		 * @param value
+		 * @param field name
+		 * @param value int value
 		 */
 		protected void contribute(String field, int value) {
 			if (buffer.length() > 0)
@@ -1563,7 +1564,10 @@ public final class MapiSocket {
 			buffer.append(value);
 		}
 
-
+		/**
+		 * Set the buffer
+		 * @param buf a non null StringBuilder object
+		 */
 		void setBuffer(StringBuilder buf) {
 			buffer = buf;
 		}
--- a/src/main/java/org/monetdb/mcl/net/Parameter.java
+++ b/src/main/java/org/monetdb/mcl/net/Parameter.java
@@ -140,7 +140,7 @@ public enum Parameter {
 	 * Note that the value returned for TIMEZONE may change if the system time zone
 	 * is changed or if Daylight Saving Time starts or ends.
 	 *
-	 * @return
+	 * @return default value for the given setting, as an Object of the appropriate type
 	 */
 	public Object getDefault() {
 		switch (this) {
--- a/src/main/java/org/monetdb/mcl/net/ParameterType.java
+++ b/src/main/java/org/monetdb/mcl/net/ParameterType.java
@@ -28,7 +28,7 @@ public enum ParameterType {
 	 */
 	Bool,
 	/**
-	 * Functionally the same as {@link ParameterType.Str } but
+	 * Functionally the same as {@link ParameterType#Str} but
 	 * indicates the value is to be interpreted as a path on the
 	 * client's file system.
 	 */