Merge branch 'develop'

Author: tsolomko

.jazzy.yaml

@@ -3,11 +3,11 @@ sourcekitten_sourcefile: docs.json
 clean: true
 author: Timofey Solomko
 module: BitByteData
-module_version: 1.1.0
+module_version: 1.1.1
 copyright: '© 2018 Timofey Solomko'
 readme: README.md
 github_url: https://github.com/tsolomko/BitByteData
-github_file_prefix: https://github.com/tsolomko/BitByteData/tree/1.1.0
+github_file_prefix: https://github.com/tsolomko/BitByteData/tree/1.1.1
 theme: fullwidth
 
 custom_categories:

BitByteData.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "BitByteData"
-  s.version      = "1.1.0"
+  s.version      = "1.1.1"
   s.summary      = "Read and write bits and bytes in Swift."
 
   s.description  = "A Swift framework with classes for reading and writing bits and bytes."

BitByteData.xcodeproj/BitByteData.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.1.0</string>
+	<string>1.1.1</string>
 	<key>CFBundleVersion</key>
-	<string>8</string>
+	<string>9</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2018 Timofey Solomko. All rights reserved.</string>
 </dict>

BitByteData.xcodeproj/TestBitByteData.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.1.0</string>
+	<string>1.1.1</string>
 	<key>CFBundleVersion</key>
-	<string>8</string>
+	<string>9</string>
 </dict>
 </plist>

BitByteData.xcodeproj/project.pbxproj

@@ -248,7 +248,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 8;
+				CURRENT_PROJECT_VERSION = 9;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -264,6 +264,7 @@
 				MACOSX_DEPLOYMENT_TARGET = 10.10;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
+				STRIP_INSTALLED_PRODUCT = NO;
 				SUPPORTED_PLATFORMS = "macosx watchsimulator iphonesimulator appletvsimulator watchos appletvos iphoneos";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				TVOS_DEPLOYMENT_TARGET = 9.0;
@@ -290,7 +291,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 8;
+				CURRENT_PROJECT_VERSION = 9;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
@@ -304,6 +305,7 @@
 				MACOSX_DEPLOYMENT_TARGET = 10.10;
 				ONLY_ACTIVE_ARCH = NO;
 				SDKROOT = macosx;
+				STRIP_INSTALLED_PRODUCT = NO;
 				SUPPORTED_PLATFORMS = "macosx watchsimulator iphonesimulator appletvsimulator watchos appletvos iphoneos";
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
 				TVOS_DEPLOYMENT_TARGET = 9.0;
@@ -318,7 +320,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 8;
+				DYLIB_CURRENT_VERSION = 9;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
@@ -337,7 +339,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 8;
+				DYLIB_CURRENT_VERSION = 9;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.1
+
+- Added missing documentation for `bitsLeft` and `bitsRead` computed properties.
+- Disable symbol stripping in archives generated by Carthage and published on GitHub Releases.
+
 ## 1.1.0
 
 - Added converting from `ByteReader` initializers to `LsbBitReader` and `MsbBitReader`, as well as `BitReader` protocol.

README.md

@@ -22,7 +22,7 @@ let package = Package(
     name: "PackageName",
     dependencies: [
         .package(url: "https://github.com/tsolomko/BitByteData.git",
-                 from: "1.0.0")
+                 from: "1.1.0")
     ],
     targets: [
         .target(
@@ -37,13 +37,13 @@ More details you can find in [Swift Package Manager's Documentation](https://git
 
 ### CocoaPods
 
-Add `pod 'BitByteData', '~> 1.0'` and `use_frameworks!` to your Podfile.
+Add `pod 'BitByteData', '~> 1.1'` and `use_frameworks!` to your Podfile.
 
 To complete installation, run `pod install`.
 
 ### Carthage
 
-Add to your Cartfile `github "tsolomko/BitByteData" ~> 1.0`.
+Add to your Cartfile `github "tsolomko/BitByteData" ~> 1.1`.
 
 Then run `carthage update`.
 

Sources/BitReader.swift

@@ -11,10 +11,10 @@ public protocol BitReader: class {
     /// True, if reader's BIT pointer is aligned with the BYTE border.
     var isAligned: Bool { get }
 
-    // Amount of bits left to read.
+    /// Amount of bits left to read.
     var bitsLeft: Int { get }
 
-    // Amount of bits that were already read.
+    /// Amount of bits that were already read.
     var bitsRead: Int { get }
 
     /// Creates an instance for reading bits (and bytes) from `data`.

Sources/LsbBitReader.swift

@@ -16,7 +16,7 @@ public final class LsbBitReader: ByteReader, BitReader {
         return self.bitMask == 1
     }
 
-    // Amount of bits left to read.
+    /// Amount of bits left to read.
     public var bitsLeft: Int {
         if self.isFinished {
             return 0
@@ -25,7 +25,7 @@ public final class LsbBitReader: ByteReader, BitReader {
         }
     }
 
-    // Amount of bits that were already read.
+    /// Amount of bits that were already read.
     public var bitsRead: Int {
         if self.isFinished {
             return 8 * self.size

Sources/MsbBitReader.swift

@@ -16,7 +16,7 @@ public final class MsbBitReader: ByteReader, BitReader {
         return self.bitMask == 128
     }
 
-    // Amount of bits left to read.
+    /// Amount of bits left to read.
     public var bitsLeft: Int {
         if self.isFinished {
             return 0
@@ -25,7 +25,7 @@ public final class MsbBitReader: ByteReader, BitReader {
         }
     }
 
-    // Amount of bits that were already read.
+    /// Amount of bits that were already read.
     public var bitsRead: Int {
         if self.isFinished {
             return 8 * self.size