Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Commit

Permalink
Update JavaDocs (0b3a380)
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 24, 2023
1 parent 6147ad0 commit c29912a
Show file tree
Hide file tree
Showing 31 changed files with 818 additions and 151 deletions.
31 changes: 19 additions & 12 deletions allclasses-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Sep 18 13:32:32 UTC 2023 -->
<title>All Classes and Interfaces (VortexSidebars 1.0.1 API)</title>
<!-- Generated by javadoc (17) on Sun Sep 24 15:34:52 UTC 2023 -->
<title>All Classes and Interfaces (VortexSidebars 1.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-09-18">
<meta name="dc.created" content="2023-09-24">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down Expand Up @@ -37,6 +37,7 @@
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
</ul>
Expand Down Expand Up @@ -64,22 +65,28 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/AnimatedText.html" title="class in us.teaminceptus.vortexsidebars.text">AnimatedText</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/Field.html" title="class in us.teaminceptus.vortexsidebars.text">Field</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a Field that holds an output.</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">Deprecated.
<div class="deprecation-comment">Use FunctionText instead.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/FieldText.html" title="class in us.teaminceptus.vortexsidebars.text">FieldText</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/Sidebar.html" title="class in us.teaminceptus.vortexsidebars">Sidebar</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">Deprecated.
<div class="deprecation-comment">Use FunctionText instead.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/FunctionText.html" title="class in us.teaminceptus.vortexsidebars.text">FunctionText</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a Sidebar that can be displayed to players.</div>
<div class="block">Works as a text object but with a lambda.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/Text.html" title="class in us.teaminceptus.vortexsidebars.text">Text</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/Sidebar.html" title="class in us.teaminceptus.vortexsidebars">Sidebar</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Represents a Sidebar that can be displayed to players.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="us/teaminceptus/vortexsidebars/text/Text.html" title="class in us.teaminceptus.vortexsidebars.text">Text</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Simple object that holds a String, used in order to allow for AnimatedText and FieldText</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="us/teaminceptus/vortexsidebars/text/TextColor.html" title="interface in us.teaminceptus.vortexsidebars.text">TextColor</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">An alternative to ChatColor that allows custom hex colors</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="us/teaminceptus/vortexsidebars/text/TextColor.html" title="interface in us.teaminceptus.vortexsidebars.text">TextColor</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">An alternative to ChatColor that allows for custom hex colors.</div>
</div>
</div>
</div>
Expand Down
7 changes: 4 additions & 3 deletions allpackages-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Sep 18 13:32:32 UTC 2023 -->
<title>All Packages (VortexSidebars 1.0.1 API)</title>
<!-- Generated by javadoc (17) on Sun Sep 24 15:34:52 UTC 2023 -->
<title>All Packages (VortexSidebars 1.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-09-18">
<meta name="dc.created" content="2023-09-24">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down Expand Up @@ -33,6 +33,7 @@
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-packages">Help</a></li>
</ul>
Expand Down
7 changes: 4 additions & 3 deletions constant-values.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Sep 18 13:32:32 UTC 2023 -->
<title>Constant Field Values (VortexSidebars 1.0.1 API)</title>
<!-- Generated by javadoc (17) on Sun Sep 24 15:34:52 UTC 2023 -->
<title>Constant Field Values (VortexSidebars 1.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-09-18">
<meta name="dc.created" content="2023-09-24">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down Expand Up @@ -33,6 +33,7 @@
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#constant-values">Help</a></li>
</ul>
Expand Down
92 changes: 92 additions & 0 deletions deprecated-list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sun Sep 24 15:34:52 UTC 2023 -->
<title>Deprecated List (VortexSidebars 1.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-09-24">
<meta name="description" content="deprecated elements">
<meta name="generator" content="javadoc/DeprecatedListWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="deprecated-list-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#deprecated">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#class">Classes</a></li>
</ul>
</div>
<ul class="block-list">
<li>
<div id="class">
<div class="caption"><span>Deprecated Classes</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-summary-item-name even-row-color"><a href="us/teaminceptus/vortexsidebars/text/Field.html" title="class in us.teaminceptus.vortexsidebars.text">us.teaminceptus.vortexsidebars.text.Field</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">Use FunctionText instead.
<p>
Note: there are no current plans to remove Field or FieldText.
</p></div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="us/teaminceptus/vortexsidebars/text/FieldText.html" title="class in us.teaminceptus.vortexsidebars.text">us.teaminceptus.vortexsidebars.text.FieldText</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">Use FunctionText instead.
<p>
Note: there are no current plans to remove Field or FieldText.
</p></div>
</div>
</div>
</div>
</li>
</ul>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
12 changes: 9 additions & 3 deletions help-doc.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Sep 18 13:32:32 UTC 2023 -->
<title>API Help (VortexSidebars 1.0.1 API)</title>
<!-- Generated by javadoc (17) on Sun Sep 24 15:34:52 UTC 2023 -->
<title>API Help (VortexSidebars 1.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-09-18">
<meta name="dc.created" content="2023-09-24">
<meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down Expand Up @@ -33,6 +33,7 @@
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li class="nav-bar-cell1-rev">Help</li>
</ul>
Expand Down Expand Up @@ -70,6 +71,7 @@ <h1 class="title">JavaDoc Help</h1>
<li><a href="#doc-file">Other Files</a></li>
<li><a href="#use">Use</a></li>
<li><a href="#tree">Tree (Class Hierarchy)</a></li>
<li><a href="#deprecated">Deprecated API</a></li>
<li><a href="#constant-values">Constant Field Values</a></li>
<li><a href="#all-packages">All Packages</a></li>
<li><a href="#all-classes">All Classes and Interfaces</a></li>
Expand Down Expand Up @@ -162,6 +164,10 @@ <h3>Tree (Class Hierarchy)</h3>
<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
</ul>
</section>
<section class="help-section" id="deprecated">
<h3>Deprecated API</h3>
<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
</section>
<section class="help-section" id="constant-values">
<h3>Constant Field Values</h3>
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
Expand Down
Loading

0 comments on commit c29912a

Please sign in to comment.