diff --git a/.jazzy.yaml b/.jazzy.yaml index 2f9df4c8..58a2ff87 100644 --- a/.jazzy.yaml +++ b/.jazzy.yaml @@ -3,11 +3,11 @@ clean: true exclude: Tests/ author: Timofey Solomko module: SWCompression -module_version: 4.0.0-dev +module_version: 4.0.0-test.1 copyright: '© 2017 Timofey Solomko' readme: README.md github_url: https://github.com/tsolomko/SWCompression -github_file_prefix: https://github.com/tsolomko/SWCompression/tree/develop +github_file_prefix: https://github.com/tsolomko/SWCompression/tree/v4.0.0-test.1 theme: fullwidth custom_categories: diff --git a/SWCompression.podspec b/SWCompression.podspec index 53dbff48..d6fa5e27 100644 --- a/SWCompression.podspec +++ b/SWCompression.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = "SWCompression" - s.version = "4.0.0-dev" + s.version = "4.0.0-test.1" s.summary = "Framework with implementations in Swift of different (de)compression algorithms" s.description = <<-DESC diff --git a/Sources/Service/Info.plist b/Sources/Service/Info.plist index e398c982..9f4b0e93 100644 --- a/Sources/Service/Info.plist +++ b/Sources/Service/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 4.0.0-dev + 4.0.0-test.1 CFBundleVersion $(CURRENT_PROJECT_VERSION) NSHumanReadableCopyright diff --git a/docs/Archives.html b/docs/Archives.html index 1a1372b6..639b7c1d 100644 --- a/docs/Archives.html +++ b/docs/Archives.html @@ -22,7 +22,7 @@ SWCompression Docs - (86% documented) + (82% documented)

@@ -81,12 +81,6 @@

- - @@ -188,9 +182,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@
  • - + - archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:) + archive(data:comment:fileName:writeHeaderCRC:isTextFile:osType:modificationTime:)
    @@ -427,8 +419,7 @@

    Return Value

    Data will be also compressed with Deflate algorithm. It will be also specified in archive’s header that the compressor used the slowest Deflate algorithm.

    -

    If during compression something goes wrong DeflateError will be thrown. -If either fileName or comment cannot be encoded with ISO Latin-1 encoding, +

    If either fileName or comment cannot be encoded with ISO Latin-1 encoding, then GzipError.cannotEncodeISOLatin1 will be thrown.

    Note

    @@ -447,8 +438,8 @@

    Declaration

    Swift

    public static func archive(data: Data, comment: String? = nil, fileName: String? = nil,
    -                               writeHeaderCRC: Bool = false, isTextFile: Bool = false,
    -                               osType: GzipHeader.FileSystemType? = nil, modificationTime: Date? = nil) throws -> Data
    + writeHeaderCRC: Bool = false, isTextFile: Bool = false, + osType: FileSystemType? = nil, modificationTime: Date? = nil) throws -> Data
    @@ -548,7 +539,7 @@

    Return Value

    Resulting archive’s data.

    - Show on GitHub + Show on GitHub
    @@ -562,7 +553,7 @@

    Return Value

    diff --git a/docs/Classes/GzipArchive/Member.html b/docs/Classes/GzipArchive/Member.html index ee53ff66..338fdfd0 100644 --- a/docs/Classes/GzipArchive/Member.html +++ b/docs/Classes/GzipArchive/Member.html @@ -23,7 +23,7 @@ SWCompression Docs - (86% documented) + (82% documented)

    @@ -82,12 +82,6 @@

  • - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ +
  • +
    + + + + splitUnarchive(archive:) + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func splitUnarchive(archive data: Data) throws -> [Data]
    + +
    +
    +
    @@ -318,7 +345,7 @@

    Return Value

    diff --git a/docs/Classes/ZipContainer.html b/docs/Classes/ZipContainer.html index e5ec6b63..0b98e060 100644 --- a/docs/Classes/ZipContainer.html +++ b/docs/Classes/ZipContainer.html @@ -23,7 +23,7 @@ SWCompression Docs - (86% documented) + (82% documented)

    @@ -82,12 +82,6 @@

  • - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@ - - @@ -188,9 +182,15 @@ - - @@ -188,9 +182,15 @@ - - @@ -189,9 +183,15 @@
  • - - - wrongCompressionMethod + + + wrongVersion
    @@ -296,12 +296,12 @@

    Declaration

    Declaration

    Swift

    -
    case wrongCompressionMethod
    +
    case wrongVersion
    - Show on GitHub + Show on GitHub
    @@ -335,7 +335,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -369,7 +369,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -403,7 +403,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -437,7 +437,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -471,7 +471,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -505,7 +505,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -539,7 +539,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -574,7 +574,7 @@

    Declaration

    - Show on GitHub + Show on GitHub
    @@ -588,7 +588,7 @@

    Declaration

    diff --git a/docs/Enums/CompressionMethod.html b/docs/Enums/CompressionMethod.html new file mode 100644 index 00000000..7109d1cd --- /dev/null +++ b/docs/Enums/CompressionMethod.html @@ -0,0 +1,457 @@ + + + + CompressionMethod Enumeration Reference + + + + + + + + + + + + + + + + +
    +

    + + SWCompression Docs + + (82% documented) +

    + +

    +

    + +
    +

    + +

    + + + View on GitHub + +

    + +
    + + + +
    + +
    + +
    +
    +

    CompressionMethod

    +
    +
    +
    public enum CompressionMethod
    + +
    +
    +

    Undocumented

    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + bzip2 + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case bzip2
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + copy + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case copy
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + deflate + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case deflate
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + lzma + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case lzma
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + lzma2 + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case lzma2
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + other + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case other
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/Enums/ContainerEntryType.html b/docs/Enums/ContainerEntryType.html index 8c1c9ee7..89e26019 100644 --- a/docs/Enums/ContainerEntryType.html +++ b/docs/Enums/ContainerEntryType.html @@ -23,7 +23,7 @@ SWCompression Docs - (86% documented) + (82% documented)

    @@ -82,12 +82,6 @@

  • - - @@ -189,9 +183,15 @@ - - @@ -189,9 +183,15 @@