Update jazzy docs

sukov · Aug 13, 2024 · ad891b4 · ad891b4
1 parent 33068b7
commit ad891b4
Show file tree

Hide file tree

Showing 23 changed files with 204 additions and 67 deletions.
diff --git a/docs/Classes.html b/docs/Classes.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/CachingPlayerItem.html b/docs/Classes/CachingPlayerItem.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -170,6 +170,33 @@ <h3 class="section-name"><span>Public init</span>
                 </div>
               </div>
               <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@CachingPlayerItem@objc(cs)CachingPlayerItem(im)initWithURL:"></a>
+                    <a name="//apple_ref/swift/Method/init(url:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@CachingPlayerItem@objc(cs)CachingPlayerItem(im)initWithURL:">init(url:<wbr>)</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 swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">)</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -183,7 +210,7 @@ <h3 class="section-name"><span>Public init</span>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>radomly</strong> generated. Requires <code>url.pathExtension</code> to not be empty otherwise the player will fail playing.</p>
+                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>randomly</strong> generated. Requires <code>url.pathExtension</code> to not be empty otherwise the player will fail playing.</p>
 
                       </div>
                       <div class="declaration">
@@ -242,7 +269,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>radomly</strong> generated.</p>
+                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>randomly</strong> generated.</p>
 
                       </div>
                       <div class="declaration">
@@ -576,7 +603,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Not implemented</p>
+                        <p>Undocumented</p>
 
                       </div>
                       <div class="declaration">
@@ -630,6 +657,33 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:17CachingPlayerItemAAC14cancelDownloadyyF"></a>
+                    <a name="//apple_ref/swift/Method/cancelDownload()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:17CachingPlayerItemAAC14cancelDownloadyyF">cancelDownload()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Cancels the download of the media file and deletes the incomplete cached file. Works only with the initializers intended for play and cache.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelDownload</span><span class="p">()</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
             <div class="task-group">
@@ -681,7 +735,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Enums/CachingPlayerItemConfiguration.html b/docs/Enums/CachingPlayerItemConfiguration.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -220,7 +220,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -133,7 +133,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Protocols/CachingPlayerItemDelegate.html b/docs/Protocols/CachingPlayerItemDelegate.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -302,7 +302,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/badge.svg b/docs/badge.svg
diff --git a/docs/docsets/CachingPlayerItem.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/CachingPlayerItem.docset/Contents/Resources/Documents/Classes.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/...sets/CachingPlayerItem.docset/Contents/Resources/Documents/Classes/CachingPlayerItem.html b/...sets/CachingPlayerItem.docset/Contents/Resources/Documents/Classes/CachingPlayerItem.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          CachingPlayerItem 1.0.5 Docs
+          CachingPlayerItem 1.1.1 Docs
         </a>
-         (91% documented)
+         (84% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -170,6 +170,33 @@ <h3 class="section-name"><span>Public init</span>
                 </div>
               </div>
               <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@CachingPlayerItem@objc(cs)CachingPlayerItem(im)initWithURL:"></a>
+                    <a name="//apple_ref/swift/Method/init(url:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@CachingPlayerItem@objc(cs)CachingPlayerItem(im)initWithURL:">init(url:<wbr>)</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 swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">)</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -183,7 +210,7 @@ <h3 class="section-name"><span>Public init</span>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>radomly</strong> generated. Requires <code>url.pathExtension</code> to not be empty otherwise the player will fail playing.</p>
+                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>randomly</strong> generated. Requires <code>url.pathExtension</code> to not be empty otherwise the player will fail playing.</p>
 
                       </div>
                       <div class="declaration">
@@ -242,7 +269,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>radomly</strong> generated.</p>
+                        <p>Play and cache remote media on a local file. <code>saveFilePath</code> is <strong>randomly</strong> generated.</p>
 
                       </div>
                       <div class="declaration">
@@ -576,7 +603,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Not implemented</p>
+                        <p>Undocumented</p>
 
                       </div>
                       <div class="declaration">
@@ -630,6 +657,33 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:17CachingPlayerItemAAC14cancelDownloadyyF"></a>
+                    <a name="//apple_ref/swift/Method/cancelDownload()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:17CachingPlayerItemAAC14cancelDownloadyyF">cancelDownload()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Cancels the download of the media file and deletes the incomplete cached file. Works only with the initializers intended for play and cache.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelDownload</span><span class="p">()</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
               </ul>
             </div>
             <div class="task-group">
@@ -681,7 +735,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2022-10-26)</p>
+      <p>&copy; 2024 <a class="link" href="https://github.com/sukov/CachingPlayerItem" target="_blank" rel="external noopener">Gorjan Shukov</a>. All rights reserved. (Last updated: 2024-08-13)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>