From f71d34510a550663788917235d62b588f03d6f70 Mon Sep 17 00:00:00 2001 From: Timofey Solomko Date: Sun, 5 Nov 2017 12:33:54 +0300 Subject: [PATCH] Prepare for first test release of 4.0.0 --- .jazzy.yaml | 4 +- SWCompression.podspec | 2 +- Sources/Service/Info.plist | 2 +- docs/Archives.html | 26 +- docs/Classes/BZip2.html | 24 +- docs/Classes/BZip2/BlockSize.html | 34 +- docs/Classes/Deflate.html | 20 +- docs/Classes/GzipArchive.html | 43 +- docs/Classes/GzipArchive/Member.html | 20 +- docs/Classes/LZMA.html | 18 +- docs/Classes/LZMA2.html | 18 +- docs/Classes/SevenZipContainer.html | 22 +- docs/Classes/TarContainer.html | 22 +- docs/Classes/XZArchive.html | 57 ++- docs/Classes/ZipContainer.html | 22 +- docs/Classes/ZlibArchive.html | 20 +- docs/Compression.html | 24 +- docs/Containers.html | 32 +- docs/Enums/BZip2Error.html | 44 +- docs/Enums/CompressionMethod.html | 457 ++++++++++++++++++ docs/Enums/ContainerEntryType.html | 42 +- docs/Enums/DeflateError.html | 24 +- .../GzipHeader => Enums}/FileSystemType.html | 260 +++++----- docs/Enums/GzipError.html | 47 +- docs/Enums/LZMA2Error.html | 26 +- docs/Enums/LZMAError.html | 32 +- docs/Enums/SevenZipError.html | 40 +- docs/Enums/TarError.html | 66 +-- docs/Enums/XZError.html | 95 ++-- docs/Enums/ZipError.html | 50 +- docs/Enums/ZlibError.html | 26 +- docs/Errors.html | 36 +- docs/Other Enums.html | 96 +++- docs/Other Protocols.html | 26 +- docs/Other Structs.html | 40 +- docs/Protocols.html | 42 +- docs/Protocols/Archive.html | 18 +- docs/Protocols/CompressionAlgorithm.html | 18 +- docs/Protocols/Container.html | 42 +- docs/Protocols/ContainerEntry.html | 42 +- docs/Protocols/ContainerEntryInfo.html | 92 +++- docs/Protocols/DecompressionAlgorithm.html | 18 +- docs/Structs/DosAttributes.html | 32 +- docs/Structs/GzipHeader.html | 119 ++--- .../Structs/GzipHeader/CompressionMethod.html | 287 ----------- docs/Structs/Permissions.html | 44 +- docs/Structs/SevenZipEntry.html | 22 +- docs/Structs/SevenZipEntryInfo.html | 44 +- docs/Structs/TarEntry.html | 22 +- docs/Structs/TarEntryInfo.html | 86 +++- docs/Structs/ZipEntry.html | 22 +- docs/Structs/ZipEntryInfo.html | 170 ++++++- docs/Structs/ZlibHeader.html | 28 +- docs/Structs/ZlibHeader/CompressionLevel.html | 24 +- .../Structs/ZlibHeader/CompressionMethod.html | 18 +- docs/badge.svg | 29 +- .../Resources/Documents/Archives.html | 26 +- .../Resources/Documents/Classes/BZip2.html | 24 +- .../Documents/Classes/BZip2/BlockSize.html | 34 +- .../Resources/Documents/Classes/Deflate.html | 20 +- .../Documents/Classes/GzipArchive.html | 43 +- .../Documents/Classes/GzipArchive/Member.html | 20 +- .../Resources/Documents/Classes/LZMA.html | 18 +- .../Resources/Documents/Classes/LZMA2.html | 18 +- .../Documents/Classes/SevenZipContainer.html | 22 +- .../Documents/Classes/TarContainer.html | 22 +- .../Documents/Classes/XZArchive.html | 57 ++- .../Documents/Classes/ZipContainer.html | 22 +- .../Documents/Classes/ZlibArchive.html | 20 +- .../Resources/Documents/Compression.html | 24 +- .../Resources/Documents/Containers.html | 32 +- .../Resources/Documents/Enums/BZip2Error.html | 44 +- .../Documents/Enums/CompressionMethod.html | 457 ++++++++++++++++++ .../Documents/Enums/ContainerEntryType.html | 42 +- .../Documents/Enums/DeflateError.html | 24 +- .../GzipHeader => Enums}/FileSystemType.html | 260 +++++----- .../Resources/Documents/Enums/GzipError.html | 47 +- .../Resources/Documents/Enums/LZMA2Error.html | 26 +- .../Resources/Documents/Enums/LZMAError.html | 32 +- .../Documents/Enums/SevenZipError.html | 40 +- .../Resources/Documents/Enums/TarError.html | 66 +-- .../Resources/Documents/Enums/XZError.html | 95 ++-- .../Resources/Documents/Enums/ZipError.html | 50 +- .../Resources/Documents/Enums/ZlibError.html | 26 +- .../Contents/Resources/Documents/Errors.html | 36 +- .../Resources/Documents/Other Enums.html | 96 +++- .../Resources/Documents/Other Protocols.html | 26 +- .../Resources/Documents/Other Structs.html | 40 +- .../Resources/Documents/Protocols.html | 42 +- .../Documents/Protocols/Archive.html | 18 +- .../Protocols/CompressionAlgorithm.html | 18 +- .../Documents/Protocols/Container.html | 42 +- .../Documents/Protocols/ContainerEntry.html | 42 +- .../Protocols/ContainerEntryInfo.html | 92 +++- .../Protocols/DecompressionAlgorithm.html | 18 +- .../Documents/Structs/DosAttributes.html | 32 +- .../Documents/Structs/GzipHeader.html | 119 ++--- .../Structs/GzipHeader/CompressionMethod.html | 287 ----------- .../Documents/Structs/Permissions.html | 44 +- .../Documents/Structs/SevenZipEntry.html | 22 +- .../Documents/Structs/SevenZipEntryInfo.html | 44 +- .../Resources/Documents/Structs/TarEntry.html | 22 +- .../Documents/Structs/TarEntryInfo.html | 86 +++- .../Resources/Documents/Structs/ZipEntry.html | 22 +- .../Documents/Structs/ZipEntryInfo.html | 170 ++++++- .../Documents/Structs/ZlibHeader.html | 28 +- .../Structs/ZlibHeader/CompressionLevel.html | 24 +- .../Structs/ZlibHeader/CompressionMethod.html | 18 +- .../Contents/Resources/Documents/index.html | 26 +- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx | Bin 73728 -> 77824 bytes docs/docsets/SWCompression.tgz | Bin 123962 -> 126042 bytes docs/index.html | 26 +- docs/search.json | 2 +- docs/undocumented.json | 118 ++++- 115 files changed, 3638 insertions(+), 2571 deletions(-) create mode 100644 docs/Enums/CompressionMethod.html rename docs/{Structs/GzipHeader => Enums}/FileSystemType.html (56%) delete mode 100644 docs/Structs/GzipHeader/CompressionMethod.html create mode 100644 docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums/CompressionMethod.html rename docs/docsets/SWCompression.docset/Contents/Resources/Documents/{Structs/GzipHeader => Enums}/FileSystemType.html (56%) delete mode 100644 docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html 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 @@
  • @@ -427,8 +419,7 @@ it might not be archived with GZip or compressed with Deflate at all.

    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 @@ then

    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 @@ then - Show on GitHub + Show on GitHub @@ -562,7 +553,7 @@ then

    © 2017 Timofey Solomko

    -

    Generated by jazzy ♪♫ v0.8.4, a Realm project.

    +

    Generated by jazzy ♪♫ v0.9.0, a Realm project.

    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 @@ +
  • + +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func splitUnarchive(archive data: Data) throws -> [Data]
    + +
    +
    +
    @@ -318,7 +345,7 @@ It may indicate that either the archive is damaged or it might not be compressed 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 @@
  • @@ -296,12 +296,12 @@ It may indicate that either data is damaged or it might not be compressed with B

    Declaration

    Swift

    -
    case wrongCompressionMethod
    +
    case wrongVersion
    @@ -335,7 +335,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -369,7 +369,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -403,7 +403,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -437,7 +437,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -471,7 +471,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -505,7 +505,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -539,7 +539,7 @@ It may indicate that either data is damaged or it might not be compressed with B @@ -574,7 +574,7 @@ Associated value of the error contains already decompressed data.

    @@ -588,7 +588,7 @@ Associated value of the error contains already decompressed data.

    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 @@