Updated JavaDocs across driver - Part 1

src/main/java/com/microsoft/sqlserver/jdbc/DataTypes.java

@@ -531,11 +531,12 @@ static JavaType of(Object obj) {
         return JavaType.OBJECT;
     }
 
-    // Retrieve JDBC to use with this Java type. By default we use the static JDBC type
-    // associated with the Java type, ignoring the JDBC type specified by the application.
-    // But this behavior is overridden for certain Java types, like InputStream, which
-    // require the JDBC type to be specified externally to be able to distinguish between
-    // ASCII and binary streams.
+    /**
+     * Returns the JDBC type to use with this Java type. We use the static JDBC type associated
+     * with the Java type by default, ignoring the JDBC type specified by the application. This
+     * behavior is overridden for certain Java types, such as InputStream, which requires the JDBC
+     * type to be specified externally in order to distinguish between.
+     */
     JDBCType getJDBCType(SSType ssType, JDBCType jdbcTypeFromApp) {
         return jdbcTypeFromJavaType;
     }
@@ -677,7 +678,7 @@ private JDBCType(Category category, int intValue, String className) {
     }
 
     /**
-     * Gets the integer value of JDBCType
+     * Returns the integer value of JDBCType
      * 
      * @return integer representation of JDBCType
      */
@@ -1093,51 +1094,60 @@ static final void throwConversionError(String fromType, String toType) throws SQ
         SQLServerException.makeFromDriverError(null, null, form.format(msgArgs), null, true);
     }
 
-    // Max length in Unicode characters allowed by the "short" NVARCHAR type.
-    // Values longer than this must use NVARCHAR(max) (Yukon or later) or NTEXT (Shiloh)
+    /**
+     * Max length in Unicode characters allowed by the "short" NVARCHAR type.
+     * Values longer than this must use NVARCHAR(max) (Yukon or later) or NTEXT (Shiloh)
+     */
     final static int SHORT_VARTYPE_MAX_CHARS = 4000;
 
-    // Max length in bytes allowed by the "short" VARBINARY/VARCHAR types.
-    // Values longer than this must use VARBINARY(max)/VARCHAR(max) (Yukon or later) or IMAGE/TEXT (Shiloh)
+    /**
+     * Max length in bytes allowed by the "short" VARBINARY/VARCHAR types.
+     * Values longer than this must use VARBINARY(max)/VARCHAR(max) (Yukon or later) or IMAGE/TEXT (Shiloh)
+     */
     final static int SHORT_VARTYPE_MAX_BYTES = 8000;
 
-    // A type with unlimited max size, known as varchar(max), varbinary(max) and nvarchar(max),
-    // which has a max size of 0xFFFF, defined by PARTLENTYPE.
+    /**
+     * A type with unlimited max size, known as varchar(max), varbinary(max) and nvarchar(max),
+     * which has a max size of 0xFFFF, defined by PARTLENTYPE.
+     */
     final static int SQL_USHORTVARMAXLEN = 65535; // 0xFFFF
 
-    // From SQL Server 2005 Books Online : ntext, text, and image (Transact-SQL)
-    // http://msdn.microsoft.com/en-us/library/ms187993.aspx
-    //
-    // image
-    // "... through 2^31 - 1 (2,147,483,687) bytes."
-    //
-    // text
-    // "... maximum length of 2^31 - 1 (2,147,483,687) characters."
-    //
-    // ntext
-    // "... maximum length of 2^30 - 1 (1,073,741,823) characters."
+    /**
+     * From SQL Server 2005 Books Online : ntext, text, and image (Transact-SQL)
+     * http://msdn.microsoft.com/en-us/library/ms187993.aspx
+     * 
+     * image
+     * "... through 2^31 - 1 (2,147,483,687) bytes."
+     * 
+     * text
+     * "... maximum length of 2^31 - 1 (2,147,483,687) characters."
+     * 
+     * ntext
+     * "... maximum length of 2^30 - 1 (1,073,741,823) characters."
+     */
     final static int NTEXT_MAX_CHARS = 0x3FFFFFFF;
     final static int IMAGE_TEXT_MAX_BYTES = 0x7FFFFFFF;
 
-    // From SQL Server 2005 Books Online : Transact-SQL Data Types
-    // http://msdn.microsoft.com/en-us/library/ms179910.aspx
-    //
-    // varbinary(max)
-    // "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size is the actual
-    // length of the data entered + 2 bytes."
-    //
-    // varchar(max)
-    // "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size is the actual
-    // length of the data entered + 2 bytes."
-    //
-    // nvarchar(max)
-    // "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size, in bytes,
-    // is two times the number of characters entered + 2 bytes."
-    //
-    // Normally, that would mean that the maximum length of nvarchar(max) data is 0x3FFFFFFE characters
-    // and that the maximum length of varchar(max) or varbinary(max) data is 0x3FFFFFFD bytes. However...
-    // Despite the documentation, SQL Server returns 2^30 - 1 and 2^31 - 1 respectively as the PRECISION
-    // of these types, so use that instead.
+    /**
+     * Transact-SQL Data Types: http://msdn.microsoft.com/en-us/library/ms179910.aspx
+     * 
+     * varbinary(max)
+     * "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size is the actual
+     * length of the data entered + 2 bytes."
+     * 
+     * varchar(max)
+     * "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size is the actual
+     * length of the data entered + 2 bytes."
+     * 
+     * nvarchar(max)
+     * "max indicates that the maximum storage size is 2^31 - 1 bytes. The storage size, in bytes,
+     * is two times the number of characters entered + 2 bytes."
+
+     * Normally, that would mean that the maximum length of nvarchar(max) data is 0x3FFFFFFE characters
+     * and that the maximum length of varchar(max) or varbinary(max) data is 0x3FFFFFFD bytes. However...
+     * Despite the documentation, SQL Server returns 2^30 - 1 and 2^31 - 1 respectively as the PRECISION
+     * of these types, so use that instead.
+     */
     final static int MAX_VARTYPE_MAX_CHARS = 0x3FFFFFFF;
     final static int MAX_VARTYPE_MAX_BYTES = 0x7FFFFFFF;