Fix typos in README and code

luben · Oct 10, 2022 · 612e7eb · 612e7eb
1 parent 451df09
commit 612e7eb
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ changing the class names will lead to failed linking at runtime.
 Building and dependencies
 -------------------------
 
-**Zstd-jni** uses SBT for building the libary and running the tests.
+**Zstd-jni** uses SBT for building the library and running the tests.
 
 The build system depends on Scala and the tests depend on ScalaTest and
 ScalaCheck but the produced JAR does not have any dependencies. It also

diff --git a/src/main/java/com/github/luben/zstd/BufferPool.java b/src/main/java/com/github/luben/zstd/BufferPool.java
@@ -3,7 +3,7 @@
 import java.nio.ByteBuffer;
 
 /**
- * An an interface that allows users to customize how buffers are recycled.
+ * An interface that allows users to customize how buffers are recycled.
  */
 public interface BufferPool {
 

diff --git a/src/main/java/com/github/luben/zstd/RecyclingBufferPool.java b/src/main/java/com/github/luben/zstd/RecyclingBufferPool.java
@@ -6,7 +6,7 @@
 import java.util.Deque;
 
 /**
- * An pool of buffers which uses a simple reference queue to recycle buffers.
+ * A pool of buffers which uses a simple reference queue to recycle buffers.
  *
  * Do not use it as generic buffer pool - it is optimized and supports only
  * buffer sizes used by the Zstd classes.

diff --git a/src/main/java/com/github/luben/zstd/Zstd.java b/src/main/java/com/github/luben/zstd/Zstd.java
@@ -715,7 +715,7 @@ public static long decompressedSize(byte[] src) {
      */
     public static native long getDictIdFromDict(byte[] dict);
 
-    /** Stub methods for backward comatibility
+    /* Stub methods for backward comatibility
      */
 
     /**

diff --git a/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java b/src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
@@ -113,7 +113,7 @@ public ZstdCompressCtx setDictID(boolean dictIDFlag) {
      * @param windowLog Maximum allowed back-reference distance, expressed as power of 2.
      *                  This will set a memory budget for streaming decompression,
      *                  with larger values requiring more memory and typically compressing more.
-     *                  Must be clamped between 10 and 32/64 but values greater then 27 may not
+     *                  Must be clamped between 10 and 32/64 but values greater than 27 may not
      *                  be decompressable in all context as they require more memory.
      *                  0 disables LDM.
      */
@@ -202,7 +202,7 @@ public void reset() {
      * the pledged size is stored in the header of the output stream, allowing decompressors to know
      * how much uncompressed data to expect.
      *
-     * Attempting to compress more or less than than the pledged size will result in an error.
+     * Attempting to compress more or less than the pledged size will result in an error.
      */
     public void setPledgedSrcSize(long srcSize) {
         ensureOpen();
@@ -326,7 +326,7 @@ public int compressByteArray(byte[] dstBuff, int dstOffset, int dstSize, byte[]
 
     private native long compressByteArray0(byte[] dst, int dstOffset, int dstSize, byte[] src, int srcOffset, int srcSize);
 
-    /** Convenience methods */
+    /* Convenience methods */
 
     /**
      * Compresses the data in buffer 'srcBuf'

diff --git a/src/main/java/com/github/luben/zstd/ZstdDecompressCtx.java b/src/main/java/com/github/luben/zstd/ZstdDecompressCtx.java
@@ -212,7 +212,7 @@ public int decompressByteArray(byte[] dstBuff, int dstOffset, int dstSize, byte[
 
     private native long decompressByteArray0(byte[] dst, int dstOffset, int dstSize, byte[] src, int srcOffset, int srcSize);
 
-    /** Covenience methods */
+    /* Covenience methods */
 
     /**
      * Decompresses buffer 'srcBuff' into buffer 'dstBuff' using this ZstdDecompressCtx.