Update documentation

lucasintel · Feb 15, 2021 · f307399 · f307399
1 parent 74977ad
commit f307399
Show file tree

Hide file tree

Showing 11 changed files with 3,297 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-/docs/
 /lib/
 /bin/
 /.shards/

diff --git a/docs/Likeer.html b/docs/Likeer.html
@@ -0,0 +1,263 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="generator" content="Crystal Docs 0.36.0">
+<meta name="crystal_docs.project_version" content="0.1.0">
+<meta name="crystal_docs.project_name" content="Likeer">
+
+
+    <link rel="canonical" href="https://kandayo.github.io/likee-scraper/Likeer.html">
+
+<link href="css/style.css" rel="stylesheet" type="text/css" />
+<script type="text/javascript" src="js/doc.js"></script>
+
+  <meta name="repository-name" content="Likeer">
+  <title>Likeer - Likeer 0.1.0</title>
+  <script type="text/javascript">
+    CrystalDocs.base_path = "";
+  </script>
+</head>
+<body>
+
+<svg class="hidden">
+  <symbol id="octicon-link" viewBox="0 0 16 16">
+    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
+  </symbol>
+</svg>
+<div class="sidebar">
+  <div class="sidebar-header">
+    <div class="search-box">
+      <input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
+    </div>
+
+    <div class="project-summary">
+      <h1 class="project-name">
+        <a href="index.html">
+          Likeer
+        </a>
+      </h1>
+
+      <span class="project-version">
+        0.1.0
+      </span>
+    </div>
+  </div>
+
+  <div class="search-results hidden">
+    <ul class="search-list"></ul>
+  </div>
+
+  <div class="types-list">
+    <ul>
+
+  <li class="parent open current" data-id="Likeer/Likeer" data-name="likeer">
+      <a href="Likeer.html">Likeer</a>
+
+        <ul>
+
+  <li class=" " data-id="Likeer/Likeer/CLI" data-name="likeer::cli">
+      <a href="Likeer/CLI.html">CLI</a>
+
+    </li>
+
+  <li class=" " data-id="Likeer/Likeer/Downloader" data-name="likeer::downloader">
+      <a href="Likeer/Downloader.html">Downloader</a>
+
+    </li>
+
+  <li class=" " data-id="Likeer/Likeer/Utils" data-name="likeer::utils">
+      <a href="Likeer/Utils.html">Utils</a>
+
+    </li>
+
+  <li class=" " data-id="Likeer/Likeer/VideoCollector" data-name="likeer::videocollector">
+      <a href="Likeer/VideoCollector.html">VideoCollector</a>
+
+    </li>
+
+</ul>
+
+
+    </li>
+
+</ul>
+
+  </div>
+</div>
+
+
+<div class="main-content">
+<h1 class="type-name">
+
+  <span class="kind">module</span> Likeer
+
+</h1>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <h2>
+    <a id="defined-in" class="anchor" href="#defined-in">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Defined in:
+  </h2>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/cli/cli.cr#L5" target="_blank">
+        cli/cli.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer.cr#L6" target="_blank">
+        likeer.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer/downloader.cr#L6" target="_blank">
+        likeer/downloader.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer/utils.cr#L3" target="_blank">
+        likeer/utils.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer/version.cr#L1" target="_blank">
+        likeer/version.cr
+      </a>
+
+    <br/>
+
+
+      <a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer/video_collector.cr#L3" target="_blank">
+        likeer/video_collector.cr
+      </a>
+
+    <br/>
+
+
+
+
+
+    <h2>
+      <a id="constant-summary" class="anchor" href="#constant-summary">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+      Constant Summary
+    </h2>
+
+  <dl>
+
+      <dt class="entry-const" id="VERSION">
+        <strong>VERSION</strong> = <code><span class="s">&quot;0.1.0&quot;</span></code>
+      </dt>
+
+
+  </dl>
+
+
+
+
+
+  <h2>
+    <a id="class-method-summary" class="anchor" href="#class-method-summary">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Class Method Summary
+  </h2>
+  <ul class="list-summary">
+
+      <li class="entry-summary">
+        <a href="#download_user_feed(uid:String)-class-method" class="signature"><strong>.download_user_feed</strong>(uid : String)</a>
+
+          <div class="summary"><p>Iterates through the user - <em>uid</em> - profile and download all videos.</p></div>
+
+      </li>
+
+  </ul>
+
+
+
+
+
+
+
+<div class="methods-inherited">
+
+</div>
+
+
+
+
+  <h2>
+    <a id="class-method-detail" class="anchor" href="#class-method-detail">
+  <svg class="octicon-link" aria-hidden="true">
+    <use href="#octicon-link"/>
+  </svg>
+</a>
+    Class Method Detail
+  </h2>
+
+    <div class="entry-detail" id="download_user_feed(uid:String)-class-method">
+      <div class="signature">
+
+        def self.<strong>download_user_feed</strong>(uid : String)
+
+        <a class="method-permalink" href="#download_user_feed(uid:String)-class-method">#</a>
+      </div>
+
+        <div class="doc">
+
+          <p>Iterates through the user - <em>uid</em> - profile and download all videos.</p>
+        </div>
+
+      <br/>
+      <div>
+
+          [<a href="https://github.com/kandayo/likee-scraper/blob/74977ad54c2eff705b1b423865e7603a531fdc8d/src/likeer.cr#L8" target="_blank">View source</a>]
+
+      </div>
+    </div>
+
+
+
+
+
+
+
+</div>
+
+</body>
+</html>