SNOW-1016469: Adding missing comments to public methods

src/main/java/net/snowflake/client/core/QueryContextCache.java

@@ -338,7 +338,7 @@ private static QueryContextElement deserializeQueryContextElementDTO(
    * Serialize the QueryContext cache to a QueryContextDTO object, which can be serialized to JSON
    * automatically later.
    *
-   * @return QueryContextDTO
+   * @return QueryContextDTO {@link QueryContextDTO}
    */
   public QueryContextDTO serializeQueryContextDTO() {
     synchronized (this) {

src/main/java/net/snowflake/client/core/ResultUtil.java

@@ -88,7 +88,7 @@ public static Object effectiveParamValue(Map<String, Object> parameters, String
    * @param id id
    * @param param timestamp output format param
    * @param defaultFormat default format
-   * @return SnowflakeDateTimeFormat
+   * @return SnowflakeDateTimeFormat {@link SnowflakeDateTimeFormat}
    */
   public static SnowflakeDateTimeFormat specializedFormatter(
       Map<String, Object> parameters, String id, String param, String defaultFormat) {

src/main/java/net/snowflake/client/core/SFBaseSession.java

@@ -290,8 +290,11 @@ public void setDatabaseMinorVersion(int databaseMinorVersion) {
   }
 
   /**
-   * Get if prepared statement logging is enabled
+   * Gets the value of CLIENT_ENABLE_LOG_INFO_STATEMENT_PARAMETERS if one has been set. False by
+   * default.
    *
+   * @see <a
+   *     href="https://docs.snowflake.com/en/sql-reference/parameters#client-enable-log-info-statement-parameters">CLIENT_ENABLE_LOG_INFO_STATEMENT_PARAMETERS</a>
    * @return true if enabled
    */
   public boolean getPreparedStatementLogging() {
@@ -301,6 +304,7 @@ public boolean getPreparedStatementLogging() {
   /**
    * Set prepared statement logging
    *
+   * @see SFBaseSession#getPreparedStatementLogging()
    * @param value boolean
    */
   public void setPreparedStatementLogging(boolean value) {
@@ -328,7 +332,9 @@ public void setInjectFileUploadFailure(String fileToFail) {
   /**
    * Get timestamp mapped type
    *
-   * @return SnowflakeType
+   * @see <a
+   *     href="https://docs.snowflake.com/en/sql-reference/parameters#client-timestamp-type-mapping">CLIENT_TIMESTAMP_TYPE_MAPPING</a>
+   * @return SnowflakeType {@link SnowflakeType}
    */
   public SnowflakeType getTimestampMappedType() {
     return timestampMappedType;
@@ -337,6 +343,7 @@ public SnowflakeType getTimestampMappedType() {
   /**
    * Set the timestamp mapped type
    *
+   * @see SFBaseSession#getTimestampMappedType()
    * @param timestampMappedType SnowflakeType
    */
   public void setTimestampMappedType(SnowflakeType timestampMappedType) {
@@ -346,6 +353,7 @@ public void setTimestampMappedType(SnowflakeType timestampMappedType) {
   /**
    * Get if result column is case-insensitive
    *
+   * @see SFBaseSession#setResultColumnCaseInsensitive(boolean)
    * @return true if result column is case-insensitive
    */
   public boolean isResultColumnCaseInsensitive() {
@@ -355,6 +363,8 @@ public boolean isResultColumnCaseInsensitive() {
   /**
    * Set if result column is case-insensitive
    *
+   * @see <a
+   *     href="https://docs.snowflake.com/en/sql-reference/parameters#client-result-column-case-insensitive">CLIENT_RESULT_COLUMN_CASE_INSENSITIVE</a>
    * @param resultColumnCaseInsensitive boolean
    */
   public void setResultColumnCaseInsensitive(boolean resultColumnCaseInsensitive) {
@@ -364,6 +374,8 @@ public void setResultColumnCaseInsensitive(boolean resultColumnCaseInsensitive)
   /**
    * Check if we want to treat decimal as int JDBC types
    *
+   * @see <a
+   *     href="https://docs.snowflake.com/en/sql-reference/parameters#jdbc-treat-decimal-as-int">JDBC_TREAT_DECIMAL_AS_INT</a>
    * @return true if decimal is treated as int
    */
   public boolean isJdbcTreatDecimalAsInt() {
@@ -373,6 +385,7 @@ public boolean isJdbcTreatDecimalAsInt() {
   /**
    * Set if decimal should be treated as int type
    *
+   * @see SFBaseSession#isJdbcTreatDecimalAsInt()
    * @param jdbcTreatDecimalAsInt boolean
    */
   public void setJdbcTreatDecimalAsInt(boolean jdbcTreatDecimalAsInt) {
@@ -696,7 +709,7 @@ public void unsetInvalidProxyHostAndPort() {
   /**
    * Get OCSP mode
    *
-   * @return OSCPMode
+   * @return OCSPMode {@link OCSPMode}
    */
   public OCSPMode getOCSPMode() {
     OCSPMode ret;
@@ -799,7 +812,7 @@ public void setMetadataRequestUseConnectionCtx(boolean enabled) {
   /**
    * Get injected delay
    *
-   * @return AtomicInteger
+   * @return AtomicInteger {@link AtomicInteger}
    */
   AtomicInteger getInjectedDelay() {
     return _injectedDelay;
@@ -876,17 +889,22 @@ public int getHeartbeatFrequency() {
   }
 
   /**
-   * Get autocommit
+   * autoCommit field specifies whether autocommit is enabled for the session. Autocommit determines
+   * whether a DML statement, when executed without an active transaction, is automatically
+   * committed after the statement successfully completes. default: true
    *
-   * @return true if autocommit is set
+   * @see <a
+   *     href="https://docs.snowflake.com/en/sql-reference/transactions#label-txn-autocommit">Transactions/Autocommit</a>
+   * @return a boolean value of autocommit field
    */
   public boolean getAutoCommit() {
     return autoCommit.get();
   }
 
   /**
-   * Set autocommit
+   * Sets value of autoCommit field
    *
+   * @see SFBaseSession#getAutoCommit()
    * @param autoCommit boolean
    */
   public void setAutoCommit(boolean autoCommit) {
@@ -912,7 +930,7 @@ public void setFormatDateWithTimezone(boolean formatDateWithTimezone) {
   }
 
   /**
-   * Get if session timezone should be used
+   * Get if session timezone should be used.
    *
    * @return true if using session timezone
    */
@@ -1242,7 +1260,7 @@ public void clearSqlWarnings() {
   /**
    * Get the SFConnectionHandler
    *
-   * @return SFConnectionHandler
+   * @return SFConnectionHandler {@link SFConnectionHandler}
    */
   public SFConnectionHandler getSfConnectionHandler() {
     return sfConnectionHandler;
@@ -1266,7 +1284,7 @@ public SFConnectionHandler getSfConnectionHandler() {
   public abstract int getMaxHttpRetries();
 
   /**
-   * @return SnowflakeConnectString
+   * @return SnowflakeConnectString {@link SnowflakeConnectString}
    */
   public abstract SnowflakeConnectString getSnowflakeConnectionString();
 

src/main/java/net/snowflake/client/core/SFBaseStatement.java

@@ -191,7 +191,7 @@ public static boolean isFileTransfer(String sql) {
    * Retrieves the current result as a ResultSet, if any. This is invoked by SnowflakeStatement and
    * should return an SFBaseResultSet, which is then wrapped in a SnowflakeResultSet.
    *
-   * @return SFBaseResultSet
+   * @return SFBaseResultSet {@link SFBaseResultSet}
    */
   public abstract SFBaseResultSet getResultSet();