Skip to content

Commit e4ad211

Browse files
Coder-256luben
authored andcommitted
Improve javadocs
1 parent 53e2087 commit e4ad211

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/main/java/com/github/luben/zstd/SequenceProducer.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
package com.github.luben.zstd;
22

33
/**
4-
* Interface for an extenal sequence producer. The class implementing
5-
* SequenceProducer must be provided by the user. To use, SequenceProducer should
6-
* be passed to `ZstdCompressCtx.registerSequenceProducer()`.
4+
* Interface for an extenal sequence producer. To register a sequence producer,
5+
* pass an object implementing this interface to
6+
* {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
77
*/
88
public interface SequenceProducer {
99
/**
1010
* Returns a pointer to the sequence producer function. This method is called
11-
* once in {@link ZstdCompressCtx registerSequenceProducer}.
12-
* @return A function pointer of type `ZSTD_sequenceProducer_F *`
11+
* once in {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
12+
* @return A function pointer of type {@code ZSTD_sequenceProducer_F *}
1313
*/
1414
public long getFunctionPointer();
1515

1616
/**
1717
* Allocate the sequence producer state. The returned pointer will be passed
1818
* to the sequence producer function. This method is called once in
1919
* {@link ZstdCompressCtx#registerSequenceProducer(SequenceProducer)}.
20-
* @return A `void *` pointer to the sequence producer state
20+
* @return A {@code void *} pointer to the sequence producer state
2121
*/
2222
public long createState();
2323

src/main/java/com/github/luben/zstd/ZstdCompressCtx.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ public ZstdCompressCtx setLong(int windowLog) {
278278

279279
/**
280280
* Register an external sequence producer
281-
* @param producer the user-defined SequenceProducer to register.
281+
* @param producer the user-defined {@link SequenceProducer} to register.
282282
*/
283283
public void registerSequenceProducer(SequenceProducer producer) {
284284
ensureOpen();

0 commit comments

Comments
 (0)