File tree 2 files changed +7
-7
lines changed
src/main/java/com/github/luben/zstd
2 files changed +7
-7
lines changed Original file line number Diff line number Diff line change 1
1
package com .github .luben .zstd ;
2
2
3
3
/**
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)} .
7
7
*/
8
8
public interface SequenceProducer {
9
9
/**
10
10
* 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 *}
13
13
*/
14
14
public long getFunctionPointer ();
15
15
16
16
/**
17
17
* Allocate the sequence producer state. The returned pointer will be passed
18
18
* to the sequence producer function. This method is called once in
19
19
* {@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
21
21
*/
22
22
public long createState ();
23
23
Original file line number Diff line number Diff line change @@ -278,7 +278,7 @@ public ZstdCompressCtx setLong(int windowLog) {
278
278
279
279
/**
280
280
* Register an external sequence producer
281
- * @param producer the user-defined SequenceProducer to register.
281
+ * @param producer the user-defined {@link SequenceProducer} to register.
282
282
*/
283
283
public void registerSequenceProducer (SequenceProducer producer ) {
284
284
ensureOpen ();
You can’t perform that action at this time.
0 commit comments