change in build.gradle to link to function in kafka javadoc

oracle · Jan 29, 2025 · 86debee · 86debee
1 parent 3e1a7b2
commit 86debee
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/build.gradle b/build.gradle
@@ -28,6 +28,7 @@ allprojects {
         options.windowTitle = "Oracle Database Transactional Event Queues Java API Reference"
         options.header = """<b>Oracle&reg; Database Transactional Event Queues Java API Reference<br>23ai</b><br>FF46992-04<br>"""
         options.bottom = """<center><small>Copyright &copy; 2001, 2024, Oracle and/or its affiliates. All rights reserved.<small></center><p><small><br></small></p>"""
+        options.links("https://kafka.apache.org/36/javadoc/")
     }
 }
 

diff --git a/clients/src/main/java/org/oracle/okafka/common/errors/ConnectionException.java b/clients/src/main/java/org/oracle/okafka/common/errors/ConnectionException.java
@@ -10,7 +10,7 @@
 import org.apache.kafka.common.KafkaException;
 
 /** 
- * If we are unable to create the desired Connection then this error is thrown.  
+ * Thrown when OKafka application fails to connect with the Oracle Database. 
  */
 public class ConnectionException extends KafkaException {
 	private static final long serialVersionUID = 1L;

diff --git a/clients/src/main/java/org/oracle/okafka/common/errors/RecordNotFoundSQLException.java b/clients/src/main/java/org/oracle/okafka/common/errors/RecordNotFoundSQLException.java
@@ -3,7 +3,7 @@
 import java.sql.SQLException;
 
 /** 
- * If a SQL query/PLSQL procedure unexpectedly returns empty result then this exception is thrown.
+ * Exception indicates that either specified topic name/id in describeTopics()/deleteTopic() call is not found.
  */
 public class RecordNotFoundSQLException extends SQLException {
 	public RecordNotFoundSQLException(String message) {