Skip to content

Commit 180b6c3

Browse files
committed
Small updates to documentation
1 parent 57a22d9 commit 180b6c3

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

Sources/BitReader.swift

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

14-
/// Creates an instance for reading `data`.
14+
/// Creates an instance for reading bits (and bytes) from `data`.
1515
init(data: Data)
1616

1717
/// Reads bit and returns it, advancing by one BIT position.

Sources/BitWriter.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public protocol BitWriter {
1414
/// True, if writer's BIT pointer is aligned with the BYTE border.
1515
var isAligned: Bool { get }
1616

17-
/// Creates an instance for writing.
17+
/// Creates an instance for writing bits (and bytes).
1818
init()
1919

2020
/// Writes `bit`, advancing by one BIT position.

Sources/ByteReader.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public class ByteReader {
2727
return self.data.endIndex <= self.offset
2828
}
2929

30-
/// Creates an instance for reading `data`.
30+
/// Creates an instance for reading bytes from `data`.
3131
public init(data: Data) {
3232
self.size = data.count
3333
self.data = data

Sources/LsbBitWriter.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public final class LsbBitWriter: BitWriter {
2222
return self.bitMask == 1
2323
}
2424

25-
/// Creates an instance for writing.
25+
/// Creates an instance for writing bits (and bytes).
2626
public init() { }
2727

2828
/// Writes `bit`, advancing by one BIT position.

Sources/MsbBitWriter.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public final class MsbBitWriter: BitWriter {
2222
return self.bitMask == 128
2323
}
2424

25-
/// Creates an instance for writing.
25+
/// Creates an instance for writing bits (and bytes).
2626
public init() { }
2727

2828
/// Writes `bit`, advancing by one BIT position.

0 commit comments

Comments
 (0)