Update Docs

This commit is contained in:
Paldiu
2022-12-14 23:08:12 -06:00
parent 43070f9e2a
commit 43dee08554
85 changed files with 803 additions and 530 deletions

View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Dec 14 12:57:20 CST 2022 -->
<!-- Generated by javadoc (17) on Wed Dec 14 23:07:37 CST 2022 -->
<title>ISchedule</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -79,6 +79,7 @@ loadScripts(document, 'script');</script>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedule</span></div>
<div class="block">This interface contains surface level methods for the <a href="../scheduler/SchedulingSystem.html" title="class in io.github.simplexdevelopment.scheduler"><code>SchedulingSystem</code></a> to use.</div>
</section>
<section class="summary">
<ul class="summary-list">
@ -145,7 +146,7 @@ loadScripts(document, 'script');</script>
<dt>Parameters:</dt>
<dd><code>service</code> - The service to use to locate the associated service pool and queue the service for execution.</dd>
<dt>Returns:</dt>
<dd>A Mono<Disposable> that can be used to cancel the service.</dd>
<dd>A Mono object that can be used to cancel the service.</dd>
</dl>
</section>
</li>
@ -157,7 +158,7 @@ loadScripts(document, 'script');</script>
<dt>Parameters:</dt>
<dd><code>service</code> - The service to run once.</dd>
<dt>Returns:</dt>
<dd>A Mono<Void> object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
<dd>A Mono object which can be used to run the service one time using <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>
@ -169,7 +170,7 @@ loadScripts(document, 'script');</script>
<dt>Parameters:</dt>
<dd><code>service</code> - The service to forcefully stop.</dd>
<dt>Returns:</dt>
<dd>A Mono<Void> object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
<dd>A Mono object which can be used to forcefully stop the service with <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>
@ -181,7 +182,7 @@ loadScripts(document, 'script');</script>
<dt>Parameters:</dt>
<dd><code>service</code> - The service to forcefully start.</dd>
<dt>Returns:</dt>
<dd>A Mono<Void> object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
<dd>A Mono object which can be used to forcefully start the service with <code>Mono.subscribe()</code>.</dd>
</dl>
</section>
</li>