Mention ByteReader's preconditions in bit readers' functions and make docs more consistent

Author: tsolomko

Sources/ByteReader.swift

@@ -37,7 +37,7 @@ public class ByteReader {
     /**
      Reads byte and returns it, advancing by one position.
 
-     - Precondition: There MUST be enough data left (`offset < size`).
+     - Precondition: There MUST be enough data left.
      */
     public func byte() -> UInt8 {
         precondition(self.offset < self.size)
@@ -48,7 +48,7 @@ public class ByteReader {
     /**
      Reads `count` bytes and returns them as an array of `UInt8`, advancing by `count` positions.
 
-     - Precondition: There MUST be enough data left (`offset + count <= size`).
+     - Precondition: There MUST be enough data left.
      - Precondition: Parameter `count` MUST not be less than 0.
      */
     public func bytes(count: Int) -> [UInt8] {
@@ -64,7 +64,7 @@ public class ByteReader {
     /**
      Reads 8 bytes and returns them as a `UInt64` number, advancing by 8 positions.
 
-     - Precondition: There MUST be enough data left to read (`offset + 8 <= size`).
+     - Precondition: There MUST be enough data left.
      */
     public func uint64() -> UInt64 {
         precondition(self.offset + 8 <= self.size)
@@ -76,7 +76,7 @@ public class ByteReader {
     /**
      Reads 4 bytes and returns them as a `UInt32` number, advancing by 4 positions.
 
-     - Precondition: There MUST be enough data left to read (`offset + 4 <= size`).
+     - Precondition: There MUST be enough data left.
      */
     public func uint32() -> UInt32 {
         precondition(self.offset + 4 <= self.size)
@@ -88,7 +88,7 @@ public class ByteReader {
     /**
      Reads 2 bytes and returns them as a `UInt16` number, advancing by 2 positions.
 
-     - Precondition: There MUST be enough data left to read (`offset + 2 <= size`).
+     - Precondition: There MUST be enough data left.
      */
     public func uint16() -> UInt16 {
         precondition(self.offset + 2 <= self.size)

Sources/LsbBitReader.swift

@@ -113,9 +113,8 @@ public final class LsbBitReader: ByteReader, BitReader {
     /**
      Reads byte and returns it, advancing by one BYTE position.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func byte() -> UInt8 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -125,9 +124,8 @@ public final class LsbBitReader: ByteReader, BitReader {
     /**
      Reads `count` bytes and returns them as an array of `UInt8`, advancing by `count` BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func bytes(count: Int) -> [UInt8] {
         precondition(isAligned, "BitReader is not aligned.")
@@ -137,9 +135,8 @@ public final class LsbBitReader: ByteReader, BitReader {
     /**
      Reads 8 bytes and returns them as a `UInt64` number, advancing by 8 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint64() -> UInt64 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -149,9 +146,8 @@ public final class LsbBitReader: ByteReader, BitReader {
     /**
      Reads 4 bytes and returns them as a `UInt32` number, advancing by 4 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint32() -> UInt32 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -161,9 +157,8 @@ public final class LsbBitReader: ByteReader, BitReader {
     /**
      Reads 2 bytes and returns them as a `UInt16` number, advancing by 2 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint16() -> UInt16 {
         precondition(isAligned, "BitReader is not aligned.")

Sources/MsbBitReader.swift

@@ -59,8 +59,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads `count` bits and returns them as a `Int` number, advancing by `count` BIT positions.
 
-     - Precondition: There MUST be enough data left.
      - Precondition: Parameter `fromBits` MUST not be less than 0.
+     - Precondition: There MUST be enough data left.
      */
     public func int(fromBits count: Int) -> Int {
         precondition(count >= 0)
@@ -113,9 +113,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads byte and returns it, advancing by one BYTE position.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func byte() -> UInt8 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -125,9 +124,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads `count` bytes and returns them as an array of `UInt8`, advancing by `count` BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func bytes(count: Int) -> [UInt8] {
         precondition(isAligned, "BitReader is not aligned.")
@@ -137,9 +135,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads 8 bytes and returns them as a `UInt64` number, advancing by 8 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint64() -> UInt64 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -149,9 +146,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads 4 bytes and returns them as a `UInt32` number, advancing by 4 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint32() -> UInt32 {
         precondition(isAligned, "BitReader is not aligned.")
@@ -161,9 +157,8 @@ public final class MsbBitReader: ByteReader, BitReader {
     /**
      Reads 2 bytes and returns them as a `UInt16` number, advancing by 2 BYTE positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
      - Precondition: Reader MUST be aligned.
+     - Precondition: There MUST be enough data left.
      */
     public override func uint16() -> UInt16 {
         precondition(isAligned, "BitReader is not aligned.")