Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AurelicButter committed Apr 27, 2022
1 parent a47da80 commit d787b30
Show file tree
Hide file tree
Showing 39 changed files with 1,592 additions and 32 deletions.
12 changes: 12 additions & 0 deletions docs/AniList.Activity.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ <h3>Classes</h3>
<li>
<a href="AniList.html">AniList</a>
<ul class="methods">
<li data-type="method"><a href="AniList.html#favouriteStudio">favouriteStudio</a></li>
<li data-type="method"><a href="AniList.html#genres">genres</a></li>
<li data-type="method"><a href="AniList.html#mediaTags">mediaTags</a></li>
<li data-type="method"><a href="AniList.html#search">search</a></li>
<li data-type="method"><a href="AniList.html#studio">studio</a></li>
</ul>
Expand All @@ -77,13 +80,17 @@ <h3>Classes</h3>
<a href="AniList.Media.html">Media</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Media.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteAnime">favouriteAnime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteManga">favouriteManga</a></li>
<li data-type="method"><a href="AniList.Media.html#manga">manga</a></li>
</ul>
</li>
<li>
<a href="AniList.People.html">People</a>
<ul class="methods">
<li data-type="method"><a href="AniList.People.html#character">character</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteChar">favouriteChar</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteStaff">favouriteStaff</a></li>
<li data-type="method"><a href="AniList.People.html#staff">staff</a></li>
</ul>
</li>
Expand All @@ -109,13 +116,16 @@ <h3>Classes</h3>
<li>
<a href="AniList.Thread.html">Thread</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Thread.html#delete">delete</a></li>
<li data-type="method"><a href="AniList.Thread.html#get">get</a></li>
<li data-type="method"><a href="AniList.Thread.html#getComments">getComments</a></li>
</ul>
</li>
<li>
<a href="AniList.User.html">User</a>
<ul class="methods">
<li data-type="method"><a href="AniList.User.html#all">all</a></li>
<li data-type="method"><a href="AniList.User.html#follow">follow</a></li>
<li data-type="method"><a href="AniList.User.html#getAuthorized">getAuthorized</a></li>
<li data-type="method"><a href="AniList.User.html#getRecentActivity">getRecentActivity</a></li>
<li data-type="method"><a href="AniList.User.html#profile">profile</a></li>
Expand Down Expand Up @@ -153,6 +163,7 @@ <h3>Global</h3>
<li><a href="global.html#MediaSort">MediaSort</a></li>
<li><a href="global.html#MediaSource">MediaSource</a></li>
<li><a href="global.html#MediaStatus">MediaStatus</a></li>
<li><a href="global.html#MediaTag">MediaTag</a></li>
<li><a href="global.html#MediaTitle">MediaTitle</a></li>
<li><a href="global.html#MediaType">MediaType</a></li>
<li><a href="global.html#MessageActivity">MessageActivity</a></li>
Expand All @@ -170,6 +181,7 @@ <h3>Global</h3>
<li><a href="global.html#StaffEntry">StaffEntry</a></li>
<li><a href="global.html#StudioEntry">StudioEntry</a></li>
<li><a href="global.html#TextActivity">TextActivity</a></li>
<li><a href="global.html#ThreadComment">ThreadComment</a></li>
<li><a href="global.html#ThreadEntry">ThreadEntry</a></li>
<li><a href="global.html#UserList">UserList</a></li>
<li><a href="global.html#UserOptions">UserOptions</a></li>
Expand Down
12 changes: 12 additions & 0 deletions docs/AniList.Lists.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ <h3>Classes</h3>
<li>
<a href="AniList.html">AniList</a>
<ul class="methods">
<li data-type="method"><a href="AniList.html#favouriteStudio">favouriteStudio</a></li>
<li data-type="method"><a href="AniList.html#genres">genres</a></li>
<li data-type="method"><a href="AniList.html#mediaTags">mediaTags</a></li>
<li data-type="method"><a href="AniList.html#search">search</a></li>
<li data-type="method"><a href="AniList.html#studio">studio</a></li>
</ul>
Expand All @@ -77,13 +80,17 @@ <h3>Classes</h3>
<a href="AniList.Media.html">Media</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Media.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteAnime">favouriteAnime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteManga">favouriteManga</a></li>
<li data-type="method"><a href="AniList.Media.html#manga">manga</a></li>
</ul>
</li>
<li>
<a href="AniList.People.html">People</a>
<ul class="methods">
<li data-type="method"><a href="AniList.People.html#character">character</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteChar">favouriteChar</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteStaff">favouriteStaff</a></li>
<li data-type="method"><a href="AniList.People.html#staff">staff</a></li>
</ul>
</li>
Expand All @@ -109,13 +116,16 @@ <h3>Classes</h3>
<li>
<a href="AniList.Thread.html">Thread</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Thread.html#delete">delete</a></li>
<li data-type="method"><a href="AniList.Thread.html#get">get</a></li>
<li data-type="method"><a href="AniList.Thread.html#getComments">getComments</a></li>
</ul>
</li>
<li>
<a href="AniList.User.html">User</a>
<ul class="methods">
<li data-type="method"><a href="AniList.User.html#all">all</a></li>
<li data-type="method"><a href="AniList.User.html#follow">follow</a></li>
<li data-type="method"><a href="AniList.User.html#getAuthorized">getAuthorized</a></li>
<li data-type="method"><a href="AniList.User.html#getRecentActivity">getRecentActivity</a></li>
<li data-type="method"><a href="AniList.User.html#profile">profile</a></li>
Expand Down Expand Up @@ -153,6 +163,7 @@ <h3>Global</h3>
<li><a href="global.html#MediaSort">MediaSort</a></li>
<li><a href="global.html#MediaSource">MediaSource</a></li>
<li><a href="global.html#MediaStatus">MediaStatus</a></li>
<li><a href="global.html#MediaTag">MediaTag</a></li>
<li><a href="global.html#MediaTitle">MediaTitle</a></li>
<li><a href="global.html#MediaType">MediaType</a></li>
<li><a href="global.html#MessageActivity">MessageActivity</a></li>
Expand All @@ -170,6 +181,7 @@ <h3>Global</h3>
<li><a href="global.html#StaffEntry">StaffEntry</a></li>
<li><a href="global.html#StudioEntry">StudioEntry</a></li>
<li><a href="global.html#TextActivity">TextActivity</a></li>
<li><a href="global.html#ThreadComment">ThreadComment</a></li>
<li><a href="global.html#ThreadEntry">ThreadEntry</a></li>
<li><a href="global.html#UserList">UserList</a></li>
<li><a href="global.html#UserOptions">UserOptions</a></li>
Expand Down
138 changes: 137 additions & 1 deletion docs/AniList.Media.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ <h3>Classes</h3>
<li>
<a href="AniList.html">AniList</a>
<ul class="methods">
<li data-type="method"><a href="AniList.html#favouriteStudio">favouriteStudio</a></li>
<li data-type="method"><a href="AniList.html#genres">genres</a></li>
<li data-type="method"><a href="AniList.html#mediaTags">mediaTags</a></li>
<li data-type="method"><a href="AniList.html#search">search</a></li>
<li data-type="method"><a href="AniList.html#studio">studio</a></li>
</ul>
Expand All @@ -77,13 +80,17 @@ <h3>Classes</h3>
<a href="AniList.Media.html">Media</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Media.html#anime">anime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteAnime">favouriteAnime</a></li>
<li data-type="method"><a href="AniList.Media.html#favouriteManga">favouriteManga</a></li>
<li data-type="method"><a href="AniList.Media.html#manga">manga</a></li>
</ul>
</li>
<li>
<a href="AniList.People.html">People</a>
<ul class="methods">
<li data-type="method"><a href="AniList.People.html#character">character</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteChar">favouriteChar</a></li>
<li data-type="method"><a href="AniList.People.html#favouriteStaff">favouriteStaff</a></li>
<li data-type="method"><a href="AniList.People.html#staff">staff</a></li>
</ul>
</li>
Expand All @@ -109,13 +116,16 @@ <h3>Classes</h3>
<li>
<a href="AniList.Thread.html">Thread</a>
<ul class="methods">
<li data-type="method"><a href="AniList.Thread.html#delete">delete</a></li>
<li data-type="method"><a href="AniList.Thread.html#get">get</a></li>
<li data-type="method"><a href="AniList.Thread.html#getComments">getComments</a></li>
</ul>
</li>
<li>
<a href="AniList.User.html">User</a>
<ul class="methods">
<li data-type="method"><a href="AniList.User.html#all">all</a></li>
<li data-type="method"><a href="AniList.User.html#follow">follow</a></li>
<li data-type="method"><a href="AniList.User.html#getAuthorized">getAuthorized</a></li>
<li data-type="method"><a href="AniList.User.html#getRecentActivity">getRecentActivity</a></li>
<li data-type="method"><a href="AniList.User.html#profile">profile</a></li>
Expand Down Expand Up @@ -153,6 +163,7 @@ <h3>Global</h3>
<li><a href="global.html#MediaSort">MediaSort</a></li>
<li><a href="global.html#MediaSource">MediaSource</a></li>
<li><a href="global.html#MediaStatus">MediaStatus</a></li>
<li><a href="global.html#MediaTag">MediaTag</a></li>
<li><a href="global.html#MediaTitle">MediaTitle</a></li>
<li><a href="global.html#MediaType">MediaType</a></li>
<li><a href="global.html#MessageActivity">MessageActivity</a></li>
Expand All @@ -170,6 +181,7 @@ <h3>Global</h3>
<li><a href="global.html#StaffEntry">StaffEntry</a></li>
<li><a href="global.html#StudioEntry">StudioEntry</a></li>
<li><a href="global.html#TextActivity">TextActivity</a></li>
<li><a href="global.html#ThreadComment">ThreadComment</a></li>
<li><a href="global.html#ThreadEntry">ThreadEntry</a></li>
<li><a href="global.html#UserList">UserList</a></li>
<li><a href="global.html#UserOptions">UserOptions</a></li>
Expand Down Expand Up @@ -259,6 +271,130 @@ <h5>Returns:</h5>
</dd>
</dl>

<h4 class="name" id="favouriteAnime">
<span class="type-signature">(async) </span>favouriteAnime<span class="signature">(id)</span
><span class="type-signature"> &rarr; {Boolean}</span>
</h4>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="media.js.html">media.js</a>, <a href="media.js.html#line55">line 55</a>
</li>
</ul>
</dd>

<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.12.0</li>
</ul>
</dd>
</dl>

<div class="description usertext">[Requires Login] Favourite/Unfavourite an anime</div>

<h5>Parameters:</h5>

<table class="params">
<thead>
<tr>
<th>Name</th>

<th>Type</th>

<th class="last">Description</th>
</tr>
</thead>

<tbody>
<tr>
<td class="name"><code>id</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last">Required. The ID tied to the AniList entry.</td>
</tr>
</tbody>
</table>

<h5>Returns:</h5>

<div class="param-desc">Returns true if added, false otherwise.</div>

<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>

<h4 class="name" id="favouriteManga">
<span class="type-signature">(async) </span>favouriteManga<span class="signature">(id)</span
><span class="type-signature"> &rarr; {Boolean}</span>
</h4>

<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="media.js.html">media.js</a>, <a href="media.js.html#line110">line 110</a>
</li>
</ul>
</dd>

<dt class="tag-since">Since:</dt>
<dd class="tag-since">
<ul class="dummy">
<li>1.12.0</li>
</ul>
</dd>
</dl>

<div class="description usertext">[Requires Login] Favourite/Unfavourite a manga</div>

<h5>Parameters:</h5>

<table class="params">
<thead>
<tr>
<th>Name</th>

<th>Type</th>

<th class="last">Description</th>
</tr>
</thead>

<tbody>
<tr>
<td class="name"><code>id</code></td>

<td class="type">
<span class="param-type">Number</span>
</td>

<td class="description last">Required. The ID tied to the AniList entry.</td>
</tr>
</tbody>
</table>

<h5>Returns:</h5>

<div class="param-desc">Returns true if added, false otherwise.</div>

<dl class="param-type">
<dt>Type</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>

<h4 class="name" id="manga">
<span class="type-signature"></span>manga<span class="signature">(id)</span
><span class="type-signature"> &rarr; {<a href="global.html#MangaEntry">MangaEntry</a>}</span>
Expand All @@ -269,7 +405,7 @@ <h4 class="name" id="manga">
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="media.js.html">media.js</a>, <a href="media.js.html#line55">line 55</a>
<a href="media.js.html">media.js</a>, <a href="media.js.html#line82">line 82</a>
</li>
</ul>
</dd>
Expand Down
Loading

0 comments on commit d787b30

Please sign in to comment.