Skip to content

Commit

Permalink
Improve javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Coder-256 authored and luben committed Nov 30, 2023
1 parent 53e2087 commit e4ad211
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions src/main/java/com/github/luben/zstd/SequenceProducer.java
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
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();

/**
* 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();

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/github/luben/zstd/ZstdCompressCtx.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down

0 comments on commit e4ad211

Please sign in to comment.