GitHub/SWCompression
1
0
Fork 0
mirror of https://github.com/tsolomko/SWCompression.git synced 2026-06-23 14:56:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rebuild jazzy docs

Browse Source
This commit is contained in:
Timofey Solomko
2017-10-28 13:16:58 +03:00
parent 86d1026d68
commit f99ef86611
116 changed files with 10990 additions and 7376 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Classes/ZipContainer.html
+73 -22
View File
@@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
SWCompression Docs
</a>
(100% documented)
(86% documented)
</p>
<p class="header-col--secondary">
@@ -112,34 +112,22 @@
<a class="nav-group-task-link" href="../Classes/SevenZipContainer.html">SevenZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SevenZipEntry.html">SevenZipEntry</a>
<a class="nav-group-task-link" href="../Structs/SevenZipEntry.html">SevenZipEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo.html">SevenZipEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/Permissions.html">– Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/DosAttributes.html">– DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/SevenZipEntryInfo/UnixType.html">– UnixType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarContainer.html">TarContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TarEntry/EntryType.html">– EntryType</a>
<a class="nav-group-task-link" href="../Structs/TarEntry.html">TarEntry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipContainer.html">ZipContainer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ZipEntry.html">ZipEntry</a>
<a class="nav-group-task-link" href="../Structs/ZipEntry.html">ZipEntry</a>
</li>
</ul>
</li>
@@ -198,6 +186,39 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ContainerEntryType.html">ContainerEntryType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ContainerEntryInfo.html">ContainerEntryInfo</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DosAttributes.html">DosAttributes</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Permissions.html">Permissions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/TarEntryInfo.html">TarEntryInfo</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ZipEntryInfo.html">ZipEntryInfo</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
@@ -223,9 +244,9 @@
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12ZipContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ"></a>
<a name="/s:13SWCompression12ZipContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/open(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4openSayAA0C5Entry_pG10Foundation4DataV9container_tKFZ">open(container:)</a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4openSayAA0B5EntryVG10Foundation4DataV9container_tKFZ">open(container:)</a>
</code>
</div>
<div class="height-container">
@@ -233,7 +254,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Processes ZIP container and returns an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code> (which are actually <code><a href="../Classes/ZipEntry.html">ZipEntry</a></code>).</p>
<p>Processes ZIP container and returns an array of <code><a href="../Structs/ZipEntry.html">ZipEntry</a></code>.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>The order of entries is defined by ZIP container and,
@@ -255,7 +276,7 @@ It may indicate that either container is damaged or it might not be ZIP containe
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></span><span class="p">]</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">open</span><span class="p">(</span><span class="n">container</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Structs/ZipEntry.html">ZipEntry</a></span><span class="p">]</span></code></pre>
</div>
</div>
@@ -280,10 +301,40 @@ It may indicate that either container is damaged or it might not be ZIP containe
</div>
<div>
<h4>Return Value</h4>
<p>Array of <code><a href="../Classes/ZipEntry.html">ZipEntry</a></code> as an array of <code><a href="../Protocols/ContainerEntry.html">ContainerEntry</a></code>.</p>
<p>Array of <code><a href="../Structs/ZipEntry.html">ZipEntry</a></code>.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0/Sources/ZipContainer.swift#L27-L57">Show on GitHub</a>
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/ZIP/ZipContainer.swift#L27-L37">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SWCompression12ZipContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ"></a>
<a name="//apple_ref/swift/Method/info(container:)" class="dashAnchor"></a>
<a class="token" href="#/s:13SWCompression12ZipContainerC4infoSayAA0B9EntryInfoVG10Foundation4DataV9container_tKFZ">info(container:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZipContainer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Container.html">Container</a></span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/tsolomko/SWCompression/tree/develop/Sources/ZIP/ZipContainer.swift#L114-L151">Show on GitHub</a>
</div>
</section>
</div>