diff --git a/docs/Classes.html b/docs/Classes.html index 8e4693a1..0daf3759 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -196,7 +196,7 @@

-

A class with unarchive function for gzip archives.

+

Provides unarchive function for GZip archives.

See more
@@ -231,12 +231,20 @@
-

Undocumented

+

Provides function to open ZIP archives (containers).

See more
+
+

Declaration

+
+

Swift

+ 
public class ZipContainer
+ +
+
- Show on GitHub + Show on GitHub
@@ -293,7 +301,7 @@
-

A class with unarchive function for Zlib archives.

+

Provides unarchive function for Zlib archives.

See more
@@ -328,7 +336,7 @@
-

Provides function to decompress data, which were compressed with DEFLATE

+

Provides function to decompress data, which were compressed with DEFLATE.

See more
@@ -363,7 +371,7 @@
-

Provides function to decompress data, which were compressed using BZip2

+

Provides function to decompress data, which were compressed using BZip2.

See more
@@ -398,7 +406,7 @@
-

A class with unarchive function for xz archives.

+

Provides unarchive function for XZ archives.

See more
diff --git a/docs/Classes/BZip2.html b/docs/Classes/BZip2.html index bde6f341..76ed3634 100644 --- a/docs/Classes/BZip2.html +++ b/docs/Classes/BZip2.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -146,7 +146,7 @@ -

Provides function to decompress data, which were compressed using BZip2

+

Provides function to decompress data, which were compressed using BZip2.

diff --git a/docs/Classes/Deflate.html b/docs/Classes/Deflate.html index 96e5067f..8b450141 100644 --- a/docs/Classes/Deflate.html +++ b/docs/Classes/Deflate.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -146,7 +146,7 @@ -

Provides function to decompress data, which were compressed with DEFLATE

+

Provides function to decompress data, which were compressed with DEFLATE.

diff --git a/docs/Classes/GzipArchive.html b/docs/Classes/GzipArchive.html index c3dade45..a18c789b 100644 --- a/docs/Classes/GzipArchive.html +++ b/docs/Classes/GzipArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -146,7 +146,7 @@ -

A class with unarchive function for gzip archives.

+

Provides unarchive function for GZip archives.

diff --git a/docs/Classes/LZMA.html b/docs/Classes/LZMA.html index 94a0806d..d5f713dc 100644 --- a/docs/Classes/LZMA.html +++ b/docs/Classes/LZMA.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

diff --git a/docs/Classes/LZMA2.html b/docs/Classes/LZMA2.html index 0684dde8..fab3990c 100644 --- a/docs/Classes/LZMA2.html +++ b/docs/Classes/LZMA2.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

diff --git a/docs/Classes/XZArchive.html b/docs/Classes/XZArchive.html index 5b803f53..4ab78488 100644 --- a/docs/Classes/XZArchive.html +++ b/docs/Classes/XZArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -146,7 +146,7 @@ -

A class with unarchive function for xz archives.

+

Provides unarchive function for XZ archives.

diff --git a/docs/Classes/ZipContainer.html b/docs/Classes/ZipContainer.html index e3326fc9..e7d22699 100644 --- a/docs/Classes/ZipContainer.html +++ b/docs/Classes/ZipContainer.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

@@ -140,7 +140,13 @@

ZipContainer

-

Undocumented

+
+
+ 
public class ZipContainer
+ +
+
+

Provides function to open ZIP archives (containers).

@@ -152,9 +158,9 @@
  • - + - open(containerData:) + open(containerData:)
    @@ -162,11 +168,86 @@
    -

    Undocumented

    +

    Processes ZIP archive (container) and returns an array of tuples (String, Data). +First member of a tuple is entry’s name, second member is entry’s data.

    + +
    +

    Important

    +

    The order of entries is defined by ZIP archive and, particularly, creator of given ZIP container. +It is likely that directories will be encountered earlier than files stored in those directories, +but one SHOULD NOT assume that this is the case.

    + +
    + +
    +

    Note

    +

    Currently, there is no universal (platform and file system independent) method to determine if entry is a directory. +One can check this by looking at the size of entry’s data (it should be 0 for directory) AND +the last character of entry’s name (it should be ‘/’). If all of these is true then entry is likely to be a directory.

    + +
    + +
    +

    Note

    +

    Only ZIP containers complying to ISO/IEC 21320-1 standard are supported.

    + +
    + +
    +

    Parameter

    +

    Parameter containerData: Data of ZIP container.

    + +
    + +
    +

    Throws

    +

    ZipError or DeflateError depending on the type of inconsistency in data. +It may indicate that either the container is damaged or it might not be ZIP container or compressed with Deflate at all.

    + +
    + +
    +

    Returns

    +

    Array of pairs (tuples) where first member is entryName and second member is entryData.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func open(containerData data: Data) throws -> [(entryName: String, entryData: Data)]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + containerData + + +
    +

    Data of ZIP container.

    + +
    +
    +
    +
    +

    Return Value

    +

    Array of pairs (tuples) where first member is entryName and second member is entryData.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/Classes/ZlibArchive.html b/docs/Classes/ZlibArchive.html index ed1774aa..df1aea0e 100644 --- a/docs/Classes/ZlibArchive.html +++ b/docs/Classes/ZlibArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A class with unarchive function for Zlib archives.

    +

    Provides unarchive function for Zlib archives.

    • diff --git a/docs/Enums.html b/docs/Enums.html index 661c1fe2..ca7e2b87 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -252,12 +252,35 @@ Associated value contains already decompressed data.

    -

    Undocumented

    +

    Error happened during processing ZIP archive (container). +It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    + + See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum ZipError: Error
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -464,8 +487,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during unarchiving xz archive. -It may indicate that either the data is damaged or it might not be xz archive at all.

    +

    Error happened during unarchiving XZ archive. +It may indicate that either the data is damaged or it might not be XZ archive at all.

    -

    Error happened during unarchiving xz archive. -It may indicate that either the data is damaged or it might not be xz archive at all.

    +

    Error happened during unarchiving XZ archive. +It may indicate that either the data is damaged or it might not be XZ archive at all.

    - -
    -
    @@ -282,9 +309,9 @@
  • - - - WrongCentralDirectoryHeaderSignature + + + MultiVolumesNotSupported
    @@ -292,11 +319,19 @@
    -

    Undocumented

    +

    Archive either spanned or consists of several volumes. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case MultiVolumesNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -318,11 +353,19 @@
    -

    Undocumented

    +

    Entry or record is encrypted. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case EncryptionNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -344,11 +387,19 @@
    -

    Undocumented

    +

    Entry contains patched data. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case PatchingNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -370,37 +421,19 @@
    -

    Undocumented

    +

    Wrong compression method of an entry.

    -
    - Show on GitHub -
    -
    - -
    • - - -
    -
    @@ -448,63 +489,19 @@
    -

    Undocumented

    +

    Wrong computed CRC32 of an entry.

    -
    - Show on GitHub -
    -
    - - - - -
    - -
    -
    -
    -

    A strucutre which provides information about gzip archive.

    +

    A structure which provides information about gzip archive.

    diff --git a/docs/Structs/GzipHeader/CompressionMethod.html b/docs/Structs/GzipHeader/CompressionMethod.html index c30caf4e..08c86cff 100644 --- a/docs/Structs/GzipHeader/CompressionMethod.html +++ b/docs/Structs/GzipHeader/CompressionMethod.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/Structs/GzipHeader/FileSystemType.html b/docs/Structs/GzipHeader/FileSystemType.html index c43e95a9..96eef7e5 100644 --- a/docs/Structs/GzipHeader/FileSystemType.html +++ b/docs/Structs/GzipHeader/FileSystemType.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/Structs/ZlibHeader.html b/docs/Structs/ZlibHeader.html index c65fb9c7..4dc1ac86 100644 --- a/docs/Structs/ZlibHeader.html +++ b/docs/Structs/ZlibHeader.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A strucutre which provides information about zlib archive.

    +

    A structure which provides information about zlib archive.

    diff --git a/docs/Structs/ZlibHeader/CompressionLevel.html b/docs/Structs/ZlibHeader/CompressionLevel.html index 4d688d75..ec102b12 100644 --- a/docs/Structs/ZlibHeader/CompressionLevel.html +++ b/docs/Structs/ZlibHeader/CompressionLevel.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/Structs/ZlibHeader/CompressionMethod.html b/docs/Structs/ZlibHeader/CompressionMethod.html index 5b34178e..ed01b887 100644 --- a/docs/Structs/ZlibHeader/CompressionMethod.html +++ b/docs/Structs/ZlibHeader/CompressionMethod.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html index 8e4693a1..0daf3759 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -196,7 +196,7 @@

    -

    A class with unarchive function for gzip archives.

    +

    Provides unarchive function for GZip archives.

    See more
    @@ -231,12 +231,20 @@
    -

    Undocumented

    +

    Provides function to open ZIP archives (containers).

    See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public class ZipContainer
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -293,7 +301,7 @@
    -

    A class with unarchive function for Zlib archives.

    +

    Provides unarchive function for Zlib archives.

    See more
    @@ -328,7 +336,7 @@
    -

    Provides function to decompress data, which were compressed with DEFLATE

    +

    Provides function to decompress data, which were compressed with DEFLATE.

    See more
    @@ -363,7 +371,7 @@
    -

    Provides function to decompress data, which were compressed using BZip2

    +

    Provides function to decompress data, which were compressed using BZip2.

    See more
    @@ -398,7 +406,7 @@
    -

    A class with unarchive function for xz archives.

    +

    Provides unarchive function for XZ archives.

    See more
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html index bde6f341..76ed3634 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/BZip2.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    Provides function to decompress data, which were compressed using BZip2

    +

    Provides function to decompress data, which were compressed using BZip2.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html index 96e5067f..8b450141 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/Deflate.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    Provides function to decompress data, which were compressed with DEFLATE

    +

    Provides function to decompress data, which were compressed with DEFLATE.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html index c3dade45..a18c789b 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/GzipArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A class with unarchive function for gzip archives.

    +

    Provides unarchive function for GZip archives.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html index 94a0806d..d5f713dc 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html index 0684dde8..fab3990c 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/LZMA2.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html index 5b803f53..4ab78488 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/XZArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A class with unarchive function for xz archives.

    +

    Provides unarchive function for XZ archives.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html index e3326fc9..e7d22699 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZipContainer.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -140,7 +140,13 @@

    ZipContainer

    -

    Undocumented

    +
    +
    + 
    public class ZipContainer
    + +
    +
    +

    Provides function to open ZIP archives (containers).

    @@ -152,9 +158,9 @@
  • - + - open(containerData:) + open(containerData:)
    @@ -162,11 +168,86 @@
    -

    Undocumented

    +

    Processes ZIP archive (container) and returns an array of tuples (String, Data). +First member of a tuple is entry’s name, second member is entry’s data.

    + +
    +

    Important

    +

    The order of entries is defined by ZIP archive and, particularly, creator of given ZIP container. +It is likely that directories will be encountered earlier than files stored in those directories, +but one SHOULD NOT assume that this is the case.

    + +
    + +
    +

    Note

    +

    Currently, there is no universal (platform and file system independent) method to determine if entry is a directory. +One can check this by looking at the size of entry’s data (it should be 0 for directory) AND +the last character of entry’s name (it should be ‘/’). If all of these is true then entry is likely to be a directory.

    + +
    + +
    +

    Note

    +

    Only ZIP containers complying to ISO/IEC 21320-1 standard are supported.

    + +
    + +
    +

    Parameter

    +

    Parameter containerData: Data of ZIP container.

    + +
    + +
    +

    Throws

    +

    ZipError or DeflateError depending on the type of inconsistency in data. +It may indicate that either the container is damaged or it might not be ZIP container or compressed with Deflate at all.

    + +
    + +
    +

    Returns

    +

    Array of pairs (tuples) where first member is entryName and second member is entryData.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func open(containerData data: Data) throws -> [(entryName: String, entryData: Data)]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + containerData + + +
    +

    Data of ZIP container.

    + +
    +
    +
    +
    +

    Return Value

    +

    Array of pairs (tuples) where first member is entryName and second member is entryData.

    - Show on GitHub + Show on GitHub
    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html index ed1774aa..df1aea0e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Classes/ZlibArchive.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A class with unarchive function for Zlib archives.

    +

    Provides unarchive function for Zlib archives.

    • diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html index 661c1fe2..ca7e2b87 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Enums.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -252,12 +252,35 @@ Associated value contains already decompressed data.

    -

    Undocumented

    +

    Error happened during processing ZIP archive (container). +It may indicate that either the data is damaged or it might not be ZIP archive (container) at all.

    + + See more
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public enum ZipError: Error
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -464,8 +487,8 @@ It may indicate that either the data is damaged or it might not be compressed wi
    -

    Error happened during unarchiving xz archive. -It may indicate that either the data is damaged or it might not be xz archive at all.

    +

    Error happened during unarchiving XZ archive. +It may indicate that either the data is damaged or it might not be XZ archive at all.

    -

    Error happened during unarchiving xz archive. -It may indicate that either the data is damaged or it might not be xz archive at all.

    +

    Error happened during unarchiving XZ archive. +It may indicate that either the data is damaged or it might not be XZ archive at all.

    - -
    -
    @@ -282,9 +309,9 @@
  • - - - WrongCentralDirectoryHeaderSignature + + + MultiVolumesNotSupported
    @@ -292,11 +319,19 @@
    -

    Undocumented

    +

    Archive either spanned or consists of several volumes. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case MultiVolumesNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -318,11 +353,19 @@
    -

    Undocumented

    +

    Entry or record is encrypted. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case EncryptionNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -344,11 +387,19 @@
    -

    Undocumented

    +

    Entry contains patched data. This feature is not supported.

    +
    +

    Declaration

    +
    +

    Swift

    + 
    case PatchingNotSupported
    + +
    +
    - Show on GitHub + Show on GitHub
    @@ -370,37 +421,19 @@
    -

    Undocumented

    +

    Wrong compression method of an entry.

    -
    - Show on GitHub -
    -
    - -
    • - - -
    -
    @@ -448,63 +489,19 @@
    -

    Undocumented

    +

    Wrong computed CRC32 of an entry.

    -
    - Show on GitHub -
    -
    - - - - -
    - -
    -
    -
    -

    A strucutre which provides information about gzip archive.

    +

    A structure which provides information about gzip archive.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html index c30caf4e..08c86cff 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/CompressionMethod.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html index c43e95a9..96eef7e5 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/GzipHeader/FileSystemType.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html index c65fb9c7..4dc1ac86 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    @@ -146,7 +146,7 @@ -

    A strucutre which provides information about zlib archive.

    +

    A structure which provides information about zlib archive.

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html index 4d688d75..ec102b12 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionLevel.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html index 5b34178e..ed01b887 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/Structs/ZlibHeader/CompressionMethod.html @@ -20,7 +20,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html index 26f4a59b..c8023a45 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/index.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/undocumented.json b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/undocumented.json index 03e16411..1862018e 100644 --- a/docs/docsets/SWCompression.docset/Contents/Resources/Documents/undocumented.json +++ b/docs/docsets/SWCompression.docset/Contents/Resources/Documents/undocumented.json @@ -1,124 +1,6 @@ { "warnings": [ - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 11, - "symbol": "ZipError", - "symbol_kind": "source.lang.swift.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 12, - "symbol": "ZipError.NotFoundCentralDirectoryEnd", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 13, - "symbol": "ZipError.WrongCentralDirectoryDisk", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 14, - "symbol": "ZipError.WrongZip64LocatorSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 15, - "symbol": "ZipError.WrongZip64EndCentralDirectorySignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 16, - "symbol": "ZipError.WrongVersion", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 17, - "symbol": "ZipError.WrongCentralDirectoryHeaderSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 18, - "symbol": "ZipError.EncryptionNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 19, - "symbol": "ZipError.PatchingNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 20, - "symbol": "ZipError.CompressionNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 21, - "symbol": "ZipError.WrongLocalHeaderSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 22, - "symbol": "ZipError.WrongLocalHeader", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 23, - "symbol": "ZipError.WrongCRC32", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 24, - "symbol": "ZipError.WrongCompressedSize", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 25, - "symbol": "ZipError.WrongUncompressedSize", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 28, - "symbol": "ZipContainer", - "symbol_kind": "source.lang.swift.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 30, - "symbol": "ZipContainer.open(containerData:)", - "symbol_kind": "source.lang.swift.decl.function.method.static", - "warning": "undocumented" - } + ], "source_directory": "/Users/timofeysolomko/Developer/SWCompression" } \ No newline at end of file diff --git a/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx b/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx index 2596dc3d..8536ab2c 100644 Binary files a/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/SWCompression.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/SWCompression.tgz b/docs/docsets/SWCompression.tgz index 6ff01686..53a0a653 100644 Binary files a/docs/docsets/SWCompression.tgz and b/docs/docsets/SWCompression.tgz differ diff --git a/docs/index.html b/docs/index.html index 26f4a59b..c8023a45 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,7 +19,7 @@ SWCompression Docs - (85% documented) + (100% documented)

    diff --git a/docs/undocumented.json b/docs/undocumented.json index 03e16411..1862018e 100644 --- a/docs/undocumented.json +++ b/docs/undocumented.json @@ -1,124 +1,6 @@ { "warnings": [ - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 11, - "symbol": "ZipError", - "symbol_kind": "source.lang.swift.decl.enum", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 12, - "symbol": "ZipError.NotFoundCentralDirectoryEnd", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 13, - "symbol": "ZipError.WrongCentralDirectoryDisk", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 14, - "symbol": "ZipError.WrongZip64LocatorSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 15, - "symbol": "ZipError.WrongZip64EndCentralDirectorySignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 16, - "symbol": "ZipError.WrongVersion", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 17, - "symbol": "ZipError.WrongCentralDirectoryHeaderSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 18, - "symbol": "ZipError.EncryptionNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 19, - "symbol": "ZipError.PatchingNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 20, - "symbol": "ZipError.CompressionNotSupported", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 21, - "symbol": "ZipError.WrongLocalHeaderSignature", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 22, - "symbol": "ZipError.WrongLocalHeader", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 23, - "symbol": "ZipError.WrongCRC32", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 24, - "symbol": "ZipError.WrongCompressedSize", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 25, - "symbol": "ZipError.WrongUncompressedSize", - "symbol_kind": "source.lang.swift.decl.enumelement", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 28, - "symbol": "ZipContainer", - "symbol_kind": "source.lang.swift.decl.class", - "warning": "undocumented" - }, - { - "file": "/Users/timofeysolomko/Developer/SWCompression/Sources/ZipContainer.swift", - "line": 30, - "symbol": "ZipContainer.open(containerData:)", - "symbol_kind": "source.lang.swift.decl.function.method.static", - "warning": "undocumented" - } + ], "source_directory": "/Users/timofeysolomko/Developer/SWCompression" } \ No newline at end of file