Skip to content

Commit a8c2ce2

Browse files
committed
Refactor: JSDoc
1 parent 7f66ba1 commit a8c2ce2

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

src/binary_reader.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import DataReader from "./data_reader.ts";
22

33
/**
4-
* This class represents a binary reader. It is similar to DataView but has an internal pointer to
5-
* automatically pop the bytes that have been already read.
4+
* This class represents a binary reader.
5+
*
6+
* @extends DataReader
67
*/
78
export default class BinaryReader extends DataReader {
89
private readonly bufferView : DataViewConstructor;
9-
10+
1011
/**
1112
* @param buffer The buffer to read from
1213
*/

src/data_reader.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* This class represents a binary reader. It is similar to DataView but has an internal pointer to
3+
* automatically pop the bytes that have been already read.
4+
*/
15
export default class DataReader {
26
public readonly buffer : ArrayBuffer;
37
public pointer : number = 0;

0 commit comments

Comments
 (0)