Skip to content

Commit eb7d561

Browse files
Andre601Andre601
committed
Add package-info.java and improve Javadoc
1 parent da06e03 commit eb7d561

39 files changed

+234
-83
lines changed

‎docs/allclasses-index.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>All Classes (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>
@@ -132,13 +132,14 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
132132
<tr id="i3" class="rowColor">
133133
<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests">GetBotAction</a></td>
134134
<th class="colLast" scope="row">
135-
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#bots" target="_blank"><code>/bots/:id</code> endpoint</a>.</div>
135+
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#bots" target="_blank"><code>/api/bots/:id</code> endpoint</a>.</div>
136136
</th>
137137
</tr>
138138
<tr id="i4" class="altColor">
139139
<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests">GetListAction</a></td>
140140
<th class="colLast" scope="row">
141-
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#lists" target="_blank"><code>/lists</code> endpoint</a>.</div>
141+
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#lists" target="_blank"><code>/api/lists</code></a>
142+
and <a href="https://botblock.org/api/docs#list" target="_blank"><code>/api/lists/:id</code></a> endpoints.</div>
142143
</th>
143144
</tr>
144145
<tr id="i5" class="rowColor">
@@ -150,7 +151,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
150151
<tr id="i6" class="altColor">
151152
<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/PostAction.html" title="class in org.botblock.javabotblockapi.requests">PostAction</a></td>
152153
<th class="colLast" scope="row">
153-
<div class="block">Class to perform post actions with.</div>
154+
<div class="block">Class used to perform POST requests towards the <a href="https://botblock.org/api/docs#count" target="_blank">/api/count</a> endpoint.</div>
154155
</th>
155156
</tr>
156157
<tr id="i7" class="rowColor">

‎docs/allclasses.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>All Classes (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>

‎docs/allpackages-index.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>All Packages (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>
@@ -108,19 +108,27 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
108108
<tbody>
109109
<tr class="altColor">
110110
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/package-summary.html">org.botblock.javabotblockapi</a></th>
111-
<td class="colLast">&nbsp;</td>
111+
<td class="colLast">
112+
<div class="block">Contains the <a href="org/botblock/javabotblockapi/BotBlockAPI.html" title="class in org.botblock.javabotblockapi"><code>BotBlockAPI</code></a> class for setting up bot tokens and sites.</div>
113+
</td>
112114
</tr>
113115
<tr class="rowColor">
114116
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/annotations/package-summary.html">org.botblock.javabotblockapi.annotations</a></th>
115-
<td class="colLast">&nbsp;</td>
117+
<td class="colLast">
118+
<div class="block">Contains annotations used within the project for various things.</div>
119+
</td>
116120
</tr>
117121
<tr class="altColor">
118122
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/exceptions/package-summary.html">org.botblock.javabotblockapi.exceptions</a></th>
119-
<td class="colLast">&nbsp;</td>
123+
<td class="colLast">
124+
<div class="block">Contsins custom exceptions this API may throw.</div>
125+
</td>
120126
</tr>
121127
<tr class="rowColor">
122128
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a></th>
123-
<td class="colLast">&nbsp;</td>
129+
<td class="colLast">
130+
<div class="block">Contains classes used for various GET and POST requests.</div>
131+
</td>
124132
</tr>
125133
</tbody>
126134
</table>

‎docs/constant-values.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>Constant Field Values (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>

‎docs/deprecated-list.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>Deprecated List (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>

‎docs/help-doc.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>API Help (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>

‎docs/index-all.html‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>Index (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>
@@ -300,7 +300,7 @@ <h2 class="title">G</h2>
300300
</dd>
301301
<dt><a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests"><span class="typeNameLink">GetBotAction</span></a> - Class in <a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a></dt>
302302
<dd>
303-
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#bots" target="_blank"><code>/bots/:id</code> endpoint</a>.</div>
303+
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#bots" target="_blank"><code>/api/bots/:id</code> endpoint</a>.</div>
304304
</dd>
305305
<dt><span class="memberNameLink"><a href="org/botblock/javabotblockapi/requests/GetBotAction.html#%3Cinit%3E()">GetBotAction()</a></span> - Constructor for class org.botblock.javabotblockapi.requests.<a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests">GetBotAction</a></dt>
306306
<dd>
@@ -444,7 +444,8 @@ <h2 class="title">G</h2>
444444
</dd>
445445
<dt><a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests"><span class="typeNameLink">GetListAction</span></a> - Class in <a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a></dt>
446446
<dd>
447-
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#lists" target="_blank"><code>/lists</code> endpoint</a>.</div>
447+
<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#lists" target="_blank"><code>/api/lists</code></a>
448+
and <a href="https://botblock.org/api/docs#list" target="_blank"><code>/api/lists/:id</code></a> endpoints.</div>
448449
</dd>
449450
<dt><span class="memberNameLink"><a href="org/botblock/javabotblockapi/requests/GetListAction.html#%3Cinit%3E()">GetListAction()</a></span> - Constructor for class org.botblock.javabotblockapi.requests.<a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests">GetListAction</a></dt>
450451
<dd>
@@ -609,13 +610,21 @@ <h2 class="title">M</h2>
609610
<h2 class="title">O</h2>
610611
<dl>
611612
<dt><a href="org/botblock/javabotblockapi/package-summary.html">org.botblock.javabotblockapi</a> - package org.botblock.javabotblockapi</dt>
612-
<dd>&nbsp;</dd>
613+
<dd>
614+
<div class="block">Contains the <a href="org/botblock/javabotblockapi/BotBlockAPI.html" title="class in org.botblock.javabotblockapi"><code>BotBlockAPI</code></a> class for setting up bot tokens and sites.</div>
615+
</dd>
613616
<dt><a href="org/botblock/javabotblockapi/annotations/package-summary.html">org.botblock.javabotblockapi.annotations</a> - package org.botblock.javabotblockapi.annotations</dt>
614-
<dd>&nbsp;</dd>
617+
<dd>
618+
<div class="block">Contains annotations used within the project for various things.</div>
619+
</dd>
615620
<dt><a href="org/botblock/javabotblockapi/exceptions/package-summary.html">org.botblock.javabotblockapi.exceptions</a> - package org.botblock.javabotblockapi.exceptions</dt>
616-
<dd>&nbsp;</dd>
621+
<dd>
622+
<div class="block">Contsins custom exceptions this API may throw.</div>
623+
</dd>
617624
<dt><a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a> - package org.botblock.javabotblockapi.requests</dt>
618-
<dd>&nbsp;</dd>
625+
<dd>
626+
<div class="block">Contains classes used for various GET and POST requests.</div>
627+
</dd>
619628
</dl>
620629
<a id="I:P">
621630
<!-- -->
@@ -624,7 +633,7 @@ <h2 class="title">P</h2>
624633
<dl>
625634
<dt><a href="org/botblock/javabotblockapi/requests/PostAction.html" title="class in org.botblock.javabotblockapi.requests"><span class="typeNameLink">PostAction</span></a> - Class in <a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a></dt>
626635
<dd>
627-
<div class="block">Class to perform post actions with.</div>
636+
<div class="block">Class used to perform POST requests towards the <a href="https://botblock.org/api/docs#count" target="_blank">/api/count</a> endpoint.</div>
628637
</dd>
629638
<dt><span class="memberNameLink"><a href="org/botblock/javabotblockapi/requests/PostAction.html#%3Cinit%3E()">PostAction()</a></span> - Constructor for class org.botblock.javabotblockapi.requests.<a href="org/botblock/javabotblockapi/requests/PostAction.html" title="class in org.botblock.javabotblockapi.requests">PostAction</a></dt>
630639
<dd>

‎docs/index.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>Overview (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>
@@ -106,19 +106,27 @@ <h1 class="title">JavaBotBlockAPI 5.1.6 API</h1>
106106
<tbody>
107107
<tr class="altColor" id="i0">
108108
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/package-summary.html">org.botblock.javabotblockapi</a></th>
109-
<td class="colLast">&nbsp;</td>
109+
<td class="colLast">
110+
<div class="block">Contains the <a href="org/botblock/javabotblockapi/BotBlockAPI.html" title="class in org.botblock.javabotblockapi"><code>BotBlockAPI</code></a> class for setting up bot tokens and sites.</div>
111+
</td>
110112
</tr>
111113
<tr class="rowColor" id="i1">
112114
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/annotations/package-summary.html">org.botblock.javabotblockapi.annotations</a></th>
113-
<td class="colLast">&nbsp;</td>
115+
<td class="colLast">
116+
<div class="block">Contains annotations used within the project for various things.</div>
117+
</td>
114118
</tr>
115119
<tr class="altColor" id="i2">
116120
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/exceptions/package-summary.html">org.botblock.javabotblockapi.exceptions</a></th>
117-
<td class="colLast">&nbsp;</td>
121+
<td class="colLast">
122+
<div class="block">Contsins custom exceptions this API may throw.</div>
123+
</td>
118124
</tr>
119125
<tr class="rowColor" id="i3">
120126
<th class="colFirst" scope="row"><a href="org/botblock/javabotblockapi/requests/package-summary.html">org.botblock.javabotblockapi.requests</a></th>
121-
<td class="colLast">&nbsp;</td>
127+
<td class="colLast">
128+
<div class="block">Contains classes used for various GET and POST requests.</div>
129+
</td>
122130
</tr>
123131
</tbody>
124132
</table>

‎docs/member-search-index.zip‎

0 Bytes
Binary file not shown.

‎docs/org/botblock/javabotblockapi/BotBlockAPI.Builder.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Wed Jan 22 12:46:26 CET 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Thu Jan 23 01:11:24 CET 2020 -->
66
<title>BotBlockAPI.Builder (JavaBotBlockAPI 5.1.6 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2020-01-22">
8+
<meta name="dc.created" content="2020-01-23">
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>

0 commit comments

Comments
 (0)