Skip to content

Commit 861b643

Browse files
Andre601Andre601
committed
Generate Javadocs.
1 parent 0168faa commit 861b643

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3047
-314
lines changed

‎docs/allclasses-index.html‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Mon Sep 30 18:18:15 CEST 2019 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Nov 14 15:06:58 CET 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8-
<meta name="dc.created" content="2019-09-30">
8+
<meta name="dc.created" content="2019-11-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>
@@ -28,7 +28,7 @@
2828
catch(err) {
2929
}
3030
//-->
31-
var data = {"i0":2,"i1":2,"i2":2,"i3":2,"i4":4};
31+
var data = {"i0":2,"i1":2,"i2":2,"i3":2,"i4":2,"i5":2,"i6":4};
3232
var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
3333
var altColor = "altColor";
3434
var rowColor = "rowColor";
@@ -114,8 +114,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
114114
<tr id="i0" class="altColor">
115115
<td class="colFirst"><a href="com/andre601/javabotblockapi/BotBlockAPI.html" title="class in com.andre601.javabotblockapi">BotBlockAPI</a></td>
116116
<th class="colLast" scope="row">
117-
<div class="block">Class for handling the sites to post to and the delay for the auto-post option in the
118-
<a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi"><code>RequestHandler</code></a>.</div>
117+
<div class="block">Class used to define the auth-tokens used for the different sites.</div>
119118
</th>
120119
</tr>
121120
<tr id="i1" class="rowColor">
@@ -125,21 +124,33 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
125124
</th>
126125
</tr>
127126
<tr id="i2" class="altColor">
128-
<td class="colFirst"><a href="com/andre601/javabotblockapi/exceptions/RatelimitedException.html" title="class in com.andre601.javabotblockapi.exceptions">RatelimitedException</a></td>
127+
<td class="colFirst"><a href="com/andre601/javabotblockapi/requests/GetAction.html" title="class in com.andre601.javabotblockapi.requests">GetAction</a></td>
129128
<th class="colLast" scope="row">
130-
<div class="block">Used when the Wrapper gets ratelimited by the BotBlockAPI.</div>
129+
<div class="block">Class to perform GET actions with.</div>
131130
</th>
132131
</tr>
133132
<tr id="i3" class="rowColor">
134-
<td class="colFirst"><a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi">RequestHandler</a></td>
133+
<td class="colFirst"><a href="com/andre601/javabotblockapi/requests/PostAction.html" title="class in com.andre601.javabotblockapi.requests">PostAction</a></td>
135134
<th class="colLast" scope="row">
136-
<div class="block">Class to handle post-requests to the <a href="https://botblock.org" target="_blank">BotBlock API</a>.</div>
135+
<div class="block">Class to perform post actions with.</div>
137136
</th>
138137
</tr>
139138
<tr id="i4" class="altColor">
139+
<td class="colFirst"><a href="com/andre601/javabotblockapi/exceptions/RatelimitedException.html" title="class in com.andre601.javabotblockapi.exceptions">RatelimitedException</a></td>
140+
<th class="colLast" scope="row">
141+
<div class="block">Used when the Wrapper gets ratelimited by the BotBlockAPI.</div>
142+
</th>
143+
</tr>
144+
<tr id="i5" class="rowColor">
145+
<td class="colFirst"><a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi">RequestHandler</a></td>
146+
<th class="colLast" scope="row">Deprecated.
147+
<div class="deprecationComment">Use <a href="com/andre601/javabotblockapi/requests/PostAction.html" title="class in com.andre601.javabotblockapi.requests"><code>PostAction</code></a> or <a href="com/andre601/javabotblockapi/requests/GetAction.html" title="class in com.andre601.javabotblockapi.requests"><code>GetAction</code></a> respectively.</div>
148+
</th>
149+
</tr>
150+
<tr id="i6" class="altColor">
140151
<td class="colFirst"><a href="com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi">Site</a></td>
141152
<th class="colLast" scope="row">
142-
<div class="block">Enum class with all currently supported sites of BotBlock.org.</div>
153+
<div class="block">Enum class containing all sites currently supported by BotBlock.org.</div>
143154
</th>
144155
</tr>
145156
</table>

‎docs/allclasses.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Mon Sep 30 18:18:15 CEST 2019 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Nov 14 15:06:58 CET 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8-
<meta name="dc.created" content="2019-09-30">
8+
<meta name="dc.created" content="2019-11-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>
@@ -24,6 +24,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
2424
<ul>
2525
<li><a href="com/andre601/javabotblockapi/BotBlockAPI.html" title="class in com.andre601.javabotblockapi">BotBlockAPI</a></li>
2626
<li><a href="com/andre601/javabotblockapi/BotBlockAPI.Builder.html" title="class in com.andre601.javabotblockapi">BotBlockAPI.Builder</a></li>
27+
<li><a href="com/andre601/javabotblockapi/requests/GetAction.html" title="class in com.andre601.javabotblockapi.requests">GetAction</a></li>
28+
<li><a href="com/andre601/javabotblockapi/requests/PostAction.html" title="class in com.andre601.javabotblockapi.requests">PostAction</a></li>
2729
<li><a href="com/andre601/javabotblockapi/exceptions/RatelimitedException.html" title="class in com.andre601.javabotblockapi.exceptions">RatelimitedException</a></li>
2830
<li><a href="com/andre601/javabotblockapi/RequestHandler.html" title="class in com.andre601.javabotblockapi">RequestHandler</a></li>
2931
<li><a href="com/andre601/javabotblockapi/Site.html" title="enum in com.andre601.javabotblockapi">Site</a></li>

‎docs/allpackages-index.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Mon Sep 30 18:18:15 CEST 2019 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Nov 14 15:06:58 CET 2019 -->
66
<title>All Packages (JavaBotBlockAPI Javadocs)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8-
<meta name="dc.created" content="2019-09-30">
8+
<meta name="dc.created" content="2019-11-14">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="script.js"></script>
@@ -114,6 +114,10 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
114114
<th class="colFirst" scope="row"><a href="com/andre601/javabotblockapi/exceptions/package-summary.html">com.andre601.javabotblockapi.exceptions</a></th>
115115
<td class="colLast">&nbsp;</td>
116116
</tr>
117+
<tr class="altColor">
118+
<th class="colFirst" scope="row"><a href="com/andre601/javabotblockapi/requests/package-summary.html">com.andre601.javabotblockapi.requests</a></th>
119+
<td class="colLast">&nbsp;</td>
120+
</tr>
117121
</tbody>
118122
</table>
119123
</li>

‎docs/com/andre601/javabotblockapi/BotBlockAPI.Builder.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Mon Sep 30 18:18:15 CEST 2019 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Nov 14 15:06:58 CET 2019 -->
66
<title>BotBlockAPI.Builder (JavaBotBlockAPI Javadocs)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8-
<meta name="dc.created" content="2019-09-30">
8+
<meta name="dc.created" content="2019-11-14">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../script.js"></script>
@@ -278,8 +278,8 @@ <h4>addAuthToken</h4>
278278
<dl>
279279
<dt><span class="paramLabel">Parameters:</span></dt>
280280
<dd><code>site</code> - The <a href="Site.html" title="enum in com.andre601.javabotblockapi"><code>Site</code></a> to get the name from.</dd>
281-
<dd><code>token</code> - The API token from the corresponding botlist. May not be null or empty.
282-
<br>You may receive the API token from the botlist.</dd>
281+
<dd><code>token</code> - The API token from the corresponding bot list. May not be null or empty.
282+
<br>You may receive the API token from the bot list.</dd>
283283
<dt><span class="returnLabel">Returns:</span></dt>
284284
<dd>The Builder after the site and token were set. Useful for chaining.</dd>
285285
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -305,8 +305,8 @@ <h4>addAuthToken</h4>
305305
<dt><span class="paramLabel">Parameters:</span></dt>
306306
<dd><code>site</code> - The name of the site. May not be null.
307307
<br>A list of supported sites can be found <a href="https://botblock.org/api/docs#count" target="_blank">here</a>.</dd>
308-
<dd><code>token</code> - The API token from the corresponding botlist. May not be null or empty.
309-
<br>You may receive the API token from the botlist.</dd>
308+
<dd><code>token</code> - The API token from the corresponding bot list. May not be null or empty.
309+
<br>You may receive the API token from the bot list.</dd>
310310
<dt><span class="returnLabel">Returns:</span></dt>
311311
<dd>The Builder after the site and token were set. Useful for chaining.</dd>
312312
<dt><span class="throwsLabel">Throws:</span></dt>

‎docs/com/andre601/javabotblockapi/BotBlockAPI.html‎

Lines changed: 64 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Mon Sep 30 18:18:15 CEST 2019 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Nov 14 15:06:58 CET 2019 -->
66
<title>BotBlockAPI (JavaBotBlockAPI Javadocs)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8-
<meta name="dc.created" content="2019-09-30">
8+
<meta name="dc.created" content="2019-11-14">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
1111
<script type="text/javascript" src="../../../script.js"></script>
@@ -28,6 +28,12 @@
2828
catch(err) {
2929
}
3030
//-->
31+
var data = {"i0":10,"i1":10};
32+
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
33+
var altColor = "altColor";
34+
var rowColor = "rowColor";
35+
var tableTab = "tableTab";
36+
var activeTableTab = "activeTableTab";
3137
var pathtoroot = "../../../";
3238
var useModuleDirectories = false;
3339
loadScripts(document, 'script');</script>
@@ -92,7 +98,7 @@
9298
<li>Detail:&nbsp;</li>
9399
<li>Field&nbsp;|&nbsp;</li>
94100
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
95-
<li>Method</li>
101+
<li><a href="#method.detail">Method</a></li>
96102
</ul>
97103
</div>
98104
<a id="skip.navbar.top">
@@ -128,8 +134,8 @@ <h2 title="Class BotBlockAPI" class="title">Class BotBlockAPI</h2>
128134
<hr>
129135
<pre>public class <span class="typeNameLabel">BotBlockAPI</span>
130136
extends java.lang.Object</pre>
131-
<div class="block">Class for handling the sites to post to and the delay for the auto-post option in the
132-
<a href="RequestHandler.html" title="class in com.andre601.javabotblockapi"><code>RequestHandler</code></a>.</div>
137+
<div class="block">Class used to define the auth-tokens used for the different sites.
138+
<br>The instance of this class will be used in the <a href="requests/PostAction.html" title="class in com.andre601.javabotblockapi.requests"><code>PostAction</code></a> class.</div>
133139
</li>
134140
</ul>
135141
</div>
@@ -184,7 +190,7 @@ <h3>Constructor Summary</h3>
184190
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,int)">BotBlockAPI</a></span>&#8203;(@NotNull java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;authTokens,
185191
int&nbsp;updateInterval)</code></th>
186192
<td class="colLast">
187-
<div class="block">Constructor to set the Map with the sites and tokens and also the update delay..</div>
193+
<div class="block">Constructor to set the Map with the sites and tokens and also the update delay.</div>
188194
</td>
189195
</tr>
190196
</table>
@@ -198,6 +204,24 @@ <h3>Constructor Summary</h3>
198204
<!-- -->
199205
</a>
200206
<h3>Method Summary</h3>
207+
<table class="memberSummary">
208+
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
209+
<tr>
210+
<th class="colFirst" scope="col">Modifier and Type</th>
211+
<th class="colSecond" scope="col">Method</th>
212+
<th class="colLast" scope="col">Description</th>
213+
</tr>
214+
<tr id="i0" class="altColor">
215+
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
216+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthTokens()">getAuthTokens</a></span>()</code></th>
217+
<td class="colLast">&nbsp;</td>
218+
</tr>
219+
<tr id="i1" class="rowColor">
220+
<td class="colFirst"><code>int</code></td>
221+
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpdateInterval()">getUpdateInterval</a></span>()</code></th>
222+
<td class="colLast">&nbsp;</td>
223+
</tr>
224+
</table>
201225
<ul class="blockList">
202226
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
203227
<!-- -->
@@ -233,8 +257,8 @@ <h4>BotBlockAPI</h4>
233257
<br>This will also set the update interval to 30 minutes.</div>
234258
<dl>
235259
<dt><span class="paramLabel">Parameters:</span></dt>
236-
<dd><code>authTokens</code> - A Map of sites and their tokens. May not be null.
237-
<br>You may receive the API-token from your botlist.</dd>
260+
<dd><code>authTokens</code> - A not null Map of sites and their tokens.
261+
<br>You may receive the API-token from your bot list.</dd>
238262
</dl>
239263
</li>
240264
</ul>
@@ -247,18 +271,46 @@ <h4>BotBlockAPI</h4>
247271
<pre>public&nbsp;BotBlockAPI&#8203;(@NotNull
248272
@NotNull java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;authTokens,
249273
int&nbsp;updateInterval)</pre>
250-
<div class="block">Constructor to set the Map with the sites and tokens and also the update delay..</div>
274+
<div class="block">Constructor to set the Map with the sites and tokens and also the update delay.</div>
251275
<dl>
252276
<dt><span class="paramLabel">Parameters:</span></dt>
253-
<dd><code>authTokens</code> - A Map of sites and their tokens. May not be null.
254-
<br>You may receive the API-token from your botlist.</dd>
277+
<dd><code>authTokens</code> - A not null Map of sites and their tokens.
278+
<br>You may receive the API-token from your bot list.</dd>
255279
<dd><code>updateInterval</code> - The update interval to set.</dd>
256280
</dl>
257281
</li>
258282
</ul>
259283
</li>
260284
</ul>
261285
</section>
286+
<!-- ============ METHOD DETAIL ========== -->
287+
<section role="region">
288+
<ul class="blockList">
289+
<li class="blockList"><a id="method.detail">
290+
<!-- -->
291+
</a>
292+
<h3>Method Detail</h3>
293+
<a id="getAuthTokens()">
294+
<!-- -->
295+
</a>
296+
<ul class="blockList">
297+
<li class="blockList">
298+
<h4>getAuthTokens</h4>
299+
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;getAuthTokens()</pre>
300+
</li>
301+
</ul>
302+
<a id="getUpdateInterval()">
303+
<!-- -->
304+
</a>
305+
<ul class="blockListLast">
306+
<li class="blockList">
307+
<h4>getUpdateInterval</h4>
308+
<pre class="methodSignature">public&nbsp;int&nbsp;getUpdateInterval()</pre>
309+
</li>
310+
</ul>
311+
</li>
312+
</ul>
313+
</section>
262314
</li>
263315
</ul>
264316
</div>
@@ -316,7 +368,7 @@ <h4>BotBlockAPI</h4>
316368
<li>Detail:&nbsp;</li>
317369
<li>Field&nbsp;|&nbsp;</li>
318370
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
319-
<li>Method</li>
371+
<li><a href="#method.detail">Method</a></li>
320372
</ul>
321373
</div>
322374
<a id="skip.navbar.bottom">

0 commit comments

Comments
 (0)