From e4ad211d5e0a86ec779b0dea0744abc83b09f861 Mon Sep 17 00:00:00 2001
From: Jacob Greenfield <jag625@lehigh.edu>
Date: Sat, 11 Nov 2023 21:25:08 +0000
Subject: [PATCH] Improve javadocs

---
 .../java/com/github/luben/zstd/SequenceProducer.java | 12 ++++++------
 .../java/com/github/luben/zstd/ZstdCompressCtx.java  |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/main/java/com/github/luben/zstd/SequenceProducer.java b/src/main/java/com/github/luben/zstd/SequenceProducer.java
index 37a3336..0c959c5 100644
--- a/src/main/java/com/github/luben/zstd/SequenceProducer.java
+++ b/src/main/java/com/github/luben/zstd/SequenceProducer.java
@@ -1,15 +1,15 @@
 package com.github.luben.zstd;
 
 /**
- * Interface for an extenal sequence producer. The class implementing
- * SequenceProducer must be provided by the user. To use, SequenceProducer should
- * be passed to `ZstdCompressCtx.registerSequenceProducer()`.
+ * Interface for an extenal sequence producer. To register a sequence producer,
+ * pass an object implementing this interface to
+ * {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
  */
 public interface SequenceProducer {
   /**
    * Returns a pointer to the sequence producer function. This method is called
-   * once in {@link ZstdCompressCtx registerSequenceProducer}.
-   * @return A function pointer of type `ZSTD_sequenceProducer_F *`
+   * once in {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
+   * @return A function pointer of type {@code ZSTD_sequenceProducer_F *}
    */
   public long getFunctionPointer();
 
@@ -17,7 +17,7 @@ public interface SequenceProducer {
    * Allocate the sequence producer state. The returned pointer will be passed
    * to the sequence producer function. This method is called once in
    * {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
-   * @return A `void *` pointer to the sequence producer state
+   * @return A {@code void *} pointer to the sequence producer state
    */
   public long createState();
 
diff --git a/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java b/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
index 49b4377..cd8ff9b 100644
--- a/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
+++ b/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
@@ -278,7 +278,7 @@ public ZstdCompressCtx setLong(int windowLog) {
 
     /**
      * Register an external sequence producer
-     * @param producer the user-defined SequenceProducer to register.
+     * @param producer the user-defined {@link SequenceProducer} to register.
      */
     public void registerSequenceProducer(SequenceProducer producer) {
         ensureOpen();