Skip to content

Commit 43dee08

Browse files
PaldiuPaldiu
committed
Update Docs
1 parent 43070f9 commit 43dee08

File tree

85 files changed

+803
-530
lines changed

Some content is hidden

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

85 files changed

+803
-530
lines changed

‎build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
}
66

77
group = 'io.github.simplex'
8-
version = '1.0.0'
8+
version = '1.0.1'
99

1010
repositories {
1111
mavenCentral()

‎build/docs/javadoc/allclasses-index.html‎

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (17) -->
5-
<title>All Classes and Interfaces (SimplexSS 1.0.0 API)</title>
5+
<title>All Classes and Interfaces (SimplexSS 1.0.1 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="class index">
@@ -61,35 +61,58 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
6161
<div class="table-header col-first">Class</div>
6262
<div class="table-header col-last">Description</div>
6363
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="io/github/simplexdevelopment/scheduler/BukkitDisposable.html" title="class in io.github.simplexdevelopment.scheduler">BukkitDisposable</a></div>
64-
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">&nbsp;</div>
64+
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
65+
<div class="block">An abstraction of the <code>BukkitTask</code> class which allows this object to be used with Reactor.</div>
66+
</div>
6567
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Context.html" title="interface in io.github.simplexdevelopment.api">Context</a>&lt;<a href="io/github/simplexdevelopment/api/Context.html" title="type parameter in Context">S</a>&gt;</div>
66-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
68+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
69+
<div class="block">A glorified wrapper class which collects an element and abstracts it behind the Reactor API.</div>
70+
</div>
6771
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ExecutableService.html" title="class in io.github.simplexdevelopment.scheduler">ExecutableService</a></div>
68-
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
72+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
73+
<div class="block">An abstract service class meant for easy implementation and creation of services.</div>
74+
</div>
6975
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/Identifier.html" title="interface in io.github.simplexdevelopment.api">Identifier</a></div>
70-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
76+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
77+
<div class="block">This interface provides a method for retrieving a name, unique identifier, and numerical id for a class.</div>
78+
</div>
7179
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/ISchedule.html" title="interface in io.github.simplexdevelopment.api">ISchedule</a></div>
72-
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
80+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
81+
<div class="block">This interface contains surface level methods for the <a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
82+
</div>
7383
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api">IService</a></div>
74-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
84+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
85+
<div class="block">Represents a service that can be registered to a <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>.</div>
86+
</div>
7587
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/Main.html" title="class in io.github.simplexdevelopment.impl">Main</a></div>
7688
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
77-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/PoolHolder.html" title="class in io.github.simplexdevelopment.impl">PoolHolder</a></div>
78-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
79-
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
80-
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
81-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a>&lt;<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin&gt;</div>
82-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
83-
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
84-
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
85-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
86-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
87-
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
89+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ReactorBukkitScheduler.html" title="class in io.github.simplexdevelopment.scheduler">ReactorBukkitScheduler</a></div>
90+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
91+
<div class="block">An abstraction layer over the <code>BukkitScheduler</code> to allow for the use as a <code>Scheduler</code>.</div>
92+
</div>
93+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler">SchedulingSystem</a>&lt;<a href="io/github/simplexdevelopment/scheduler/SchedulingSystem.html" title="type parameter in SchedulingSystem">T</a> extends org.bukkit.plugin.java.JavaPlugin&gt;</div>
94+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
95+
<div class="block">This class is used to manage the scheduling of <a href="io/github/simplexdevelopment/api/IService.html" title="interface in io.github.simplexdevelopment.api"><code>IService</code></a>s,
96+
and the creation of <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s through the <a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServiceManager</code></a>.</div>
97+
</div>
98+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServiceException.html" title="class in io.github.simplexdevelopment.api">ServiceException</a></div>
99+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
100+
<div class="block">This class is used to represent a service exception.</div>
101+
</div>
102+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/impl/ServiceImpl.html" title="class in io.github.simplexdevelopment.impl">ServiceImpl</a></div>
88103
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
89-
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
90-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
91-
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
92-
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
104+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServiceManager.html" title="class in io.github.simplexdevelopment.scheduler">ServiceManager</a></div>
105+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
106+
<div class="block">The ServiceManager is a factory class for managing <a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler"><code>ServicePool</code></a>s.</div>
107+
</div>
108+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/github/simplexdevelopment/scheduler/ServicePool.html" title="class in io.github.simplexdevelopment.scheduler">ServicePool</a></div>
109+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
110+
<div class="block">A service pool is a collection of services which are managed by a single scheduler.</div>
111+
</div>
112+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/github/simplexdevelopment/api/ServicePoolException.html" title="class in io.github.simplexdevelopment.api">ServicePoolException</a></div>
113+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
114+
<div class="block">This class is used to represent a service pool exception.</div>
115+
</div>
93116
</div>
94117
</div>
95118
</div>

‎build/docs/javadoc/allpackages-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (17) -->
5-
<title>All Packages (SimplexSS 1.0.0 API)</title>
5+
<title>All Packages (SimplexSS 1.0.1 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="package index">

‎build/docs/javadoc/deprecated-list.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (17) -->
5-
<title>Deprecated List (SimplexSS 1.0.0 API)</title>
5+
<title>Deprecated List (SimplexSS 1.0.1 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="deprecated elements">

‎build/docs/javadoc/help-doc.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (17) -->
5-
<title>API Help (SimplexSS 1.0.0 API)</title>
5+
<title>API Help (SimplexSS 1.0.1 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="help">

0 commit comments

Comments
 (0)