...

deephaven · Aug 21, 2024 · 17a24cf · 17a24cf
1 parent 8f3940f
commit 17a24cf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java b/extensions/kafka/src/main/java/io/deephaven/kafka/KafkaTools.java
@@ -1299,6 +1299,9 @@ private static ConsumeStruct getConsumeStruct(
 
     /**
      * Construct a {@link TableDefinition} based on the input Properties and {@link Consume.KeyOrValueSpec} parameters.
+     * Given the same input Properties and Consume.KeyOrValueSpec parameters, the returned TableDefinition is the same
+     * as the TableDefinition of the table produced by
+     * {@link #consumeToTable(Properties, String, IntPredicate, IntToLongFunction, Consume.KeyOrValueSpec, Consume.KeyOrValueSpec, TableType)}
      *
      * @param kafkaProperties Properties to configure this table
      * @param keySpec Conversion specification for Kafka record keys