From 1c7fe6c4047b137b9513a35c0db0c4b3380a5041 Mon Sep 17 00:00:00 2001 From: BiSaXa <1669855+BiSaXa@users.noreply.github.com> Date: Sun, 11 Sep 2022 10:37:54 +0300 Subject: slight change for go doc --- bitreader.go | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'bitreader.go') diff --git a/bitreader.go b/bitreader.go index 3fbc221..a56aab8 100644 --- a/bitreader.go +++ b/bitreader.go @@ -15,11 +15,16 @@ import ( // ReaderType is the main structure of our Reader. // Whenever index == 0, we need to read a new byte from stream into curByte +// +// stream io.Reader The underlying stream we're reading bytes from +// index uint18 The current index into the byte [0-7] +// curByte byte The byte we're currently reading from +// le bool Whether to read in little-endian order type ReaderType struct { - stream io.Reader // The underlying stream we're reading bytes from - index uint8 // The current index into the byte [0-7] - curByte byte // The byte we're currently reading from - le bool // Whether to read in little-endian order + stream io.Reader + index uint8 + curByte byte + le bool } // Reader is the main constructor that creates the ReaderType object -- cgit v1.2.3