Improve docs

luben · Nov 30, 2023 · b55246e · b55246e
1 parent ae1ad52
commit b55246e
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java b/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
@@ -300,7 +300,7 @@ public void registerSequenceProducer(SequenceProducer producer) {
 
     /**
      * Enable or disable sequence producer fallback
-     * @param fallbackFlag Fall back to an internal sequence producer if a registered external
+     * @param fallbackFlag fall back to the default internal sequence producer if an external
      *                     sequence producer returns an error code, default: false
      */
     public ZstdCompressCtx setSequenceProducerFallback(boolean fallbackFlag){
@@ -312,6 +312,11 @@ public ZstdCompressCtx setSequenceProducerFallback(boolean fallbackFlag){
     }
     private static native void setSequenceProducerFallback0(long ptr, boolean fallbackFlag);
 
+    /**
+     * Enable or disable sequence validation. Useful for the sequence-level API
+     * and with external sequence producers.
+     * @param validateSequences whether to validate all sequences, default: false
+     */
     public ZstdCompressCtx setValidateSequences(boolean validateSequences) {
         ensureOpen();
         acquireSharedLock();