Documentation for error enum added

DroidsOnRoids · Feb 26, 2016 · 74dfaef · 74dfaef
1 parent eee3059
commit 74dfaef
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/NSData+Compressor.swift b/NSData+Compressor.swift
@@ -45,8 +45,19 @@ public enum CompressionAlgorithm {
 
 public enum CompressionError: ErrorType {
 
+    /**
+     The error received when trying to compress/decompress empty data (when length equals zero).
+     */
     case EmptyData
+
+    /**
+     The error received when `compression_stream_init` failed. It also fails when trying to decompress `NSData` compressed with different compression algorithm or uncompressed raw data.
+     */
     case InitError
+
+    /**
+     The error received when `compression_stream_process` failed.
+     */
     case ProcessError
 
 }

diff --git a/SwiftCompressor.podspec b/SwiftCompressor.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "SwiftCompressor"
-  s.version          = "0.1.0"
+  s.version          = "0.1.1"
   s.summary          = "Compression framework easily"
   s.description      = "SwiftCompressor lets you use Compression framework easily"
   s.homepage         = "https://github.com/DroidsOnRoids/SwiftCompressor"