Skip to content

Commit 105f51e

Browse files
committed
Improved wording of some javadoc
1 parent ee61d73 commit 105f51e

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

src/main/java/io/kaitai/struct/ByteBufferKaitaiStream.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,12 @@
3434

3535
/**
3636
* An implementation of {@link KaitaiStream} backed by a {@link ByteBuffer}.
37-
* It can be either a {@link MappedByteBuffer} backed by {@link FileChannel},
38-
* or a regular wrapper over a given byte array).
37+
* Any underlying implementation of ByteBuffer can be used, for example:
38+
* <ul>
39+
* <li>ByteBuffer returned as result of {@link ByteBuffer#wrap}, wrapping
40+
* a byte array into a buffer.</li>
41+
* <li>{@link MappedByteBuffer} backed by {@link FileChannel}</li>
42+
* </ul>
3943
*/
4044
public class ByteBufferKaitaiStream extends KaitaiStream {
4145
private FileChannel fc;

src/main/java/io/kaitai/struct/CustomDecoder.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@
2424
package io.kaitai.struct;
2525

2626
/**
27-
* A custom decoder interface. Implementing classes can be called
28-
* from inside a .ksy file using `process: XXX` syntax.
27+
* Custom decoder interface allows implementation of "byte array in - byte array
28+
* out" decoders, compatible with Kaitai Struct. Classes implementing this
29+
* interface can be called rom inside a .ksy file using `process: XXX` syntax.
30+
* @see <a href="https://doc.kaitai.io/user_guide.html#custom-process">Kaitai
31+
* Struct documentation on custom processing routines</a>
2932
*/
3033
public interface CustomDecoder {
3134
/**

0 commit comments

Comments
 (0)