Skip to content

Commit dcc9c73

Browse files
committed
Fix missing docs for bitsLeft and bitsRead properties
1 parent 4833577 commit dcc9c73

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

Sources/BitReader.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ public protocol BitReader: class {
1111
/// True, if reader's BIT pointer is aligned with the BYTE border.
1212
var isAligned: Bool { get }
1313

14-
// Amount of bits left to read.
14+
/// Amount of bits left to read.
1515
var bitsLeft: Int { get }
1616

17-
// Amount of bits that were already read.
17+
/// Amount of bits that were already read.
1818
var bitsRead: Int { get }
1919

2020
/// Creates an instance for reading bits (and bytes) from `data`.

Sources/LsbBitReader.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public final class LsbBitReader: ByteReader, BitReader {
1616
return self.bitMask == 1
1717
}
1818

19-
// Amount of bits left to read.
19+
/// Amount of bits left to read.
2020
public var bitsLeft: Int {
2121
if self.isFinished {
2222
return 0
@@ -25,7 +25,7 @@ public final class LsbBitReader: ByteReader, BitReader {
2525
}
2626
}
2727

28-
// Amount of bits that were already read.
28+
/// Amount of bits that were already read.
2929
public var bitsRead: Int {
3030
if self.isFinished {
3131
return 8 * self.size

Sources/MsbBitReader.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public final class MsbBitReader: ByteReader, BitReader {
1616
return self.bitMask == 128
1717
}
1818

19-
// Amount of bits left to read.
19+
/// Amount of bits left to read.
2020
public var bitsLeft: Int {
2121
if self.isFinished {
2222
return 0
@@ -25,7 +25,7 @@ public final class MsbBitReader: ByteReader, BitReader {
2525
}
2626
}
2727

28-
// Amount of bits that were already read.
28+
/// Amount of bits that were already read.
2929
public var bitsRead: Int {
3030
if self.isFinished {
3131
return 8 * self.size

0 commit comments

Comments
 (0)