Update jazzy docs

sukov · Aug 19, 2024 · 3626ac3 · 3626ac3
1 parent 4fd9bfc
commit 3626ac3
Show file tree

Hide file tree

Showing 22 changed files with 172 additions and 72 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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -183,7 +183,7 @@ <h3 class="section-name"><span>Public init</span>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</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">
@@ -194,6 +194,25 @@ <h4>Declaration</h4>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>url</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>URL referencing the media file.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -603,7 +622,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>Play media using an AVAsset. Caching is <strong>not</strong> supported for this method.</p>
 
                       </div>
                       <div class="declaration">
@@ -614,6 +633,37 @@ <h4>Declaration</h4>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>asset</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>An instance of AVAsset.</p>
+                                </div>
+                              </td>
+                            </tr>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>automaticallyLoadedAssetKeys</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>An NSArray of NSStrings, each representing a property key defined by AVAsset.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -735,7 +785,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -220,7 +220,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -133,7 +133,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -302,7 +302,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -183,7 +183,7 @@ <h3 class="section-name"><span>Public init</span>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</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">
@@ -194,6 +194,25 @@ <h4>Declaration</h4>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>url</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>URL referencing the media file.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -603,7 +622,7 @@ <h4>Parameters</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Undocumented</p>
+                        <p>Play media using an AVAsset. Caching is <strong>not</strong> supported for this method.</p>
 
                       </div>
                       <div class="declaration">
@@ -614,6 +633,37 @@ <h4>Declaration</h4>
 
                         </div>
                       </div>
+                      <div>
+                        <h4>Parameters</h4>
+                        <table class="graybox">
+                          <tbody>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>asset</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>An instance of AVAsset.</p>
+                                </div>
+                              </td>
+                            </tr>
+                            <tr>
+                              <td>
+                                <code>
+                                <em>automaticallyLoadedAssetKeys</em>
+                                </code>
+                              </td>
+                              <td>
+                                <div>
+                                  <p>An NSArray of NSStrings, each representing a property key defined by AVAsset.</p>
+                                </div>
+                              </td>
+                            </tr>
+                          </tbody>
+                        </table>
+                      </div>
                     </section>
                   </div>
                 </li>
@@ -735,7 +785,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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/docsets/CachingPlayerItem.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/CachingPlayerItem.docset/Contents/Resources/Documents/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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -132,7 +132,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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/...gPlayerItem.docset/Contents/Resources/Documents/Enums/CachingPlayerItemConfiguration.html b/...gPlayerItem.docset/Contents/Resources/Documents/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.1.1 Docs
+          CachingPlayerItem 1.1.3 Docs
         </a>
-         (84% documented)
+         (92% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -220,7 +220,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <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>&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-19)</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>