update javadocs

This commit is contained in:
2022-07-13 21:42:01 -05:00
parent 21e269497a
commit 34d9a2326e
123 changed files with 3534 additions and 2111 deletions

View File

@ -82,8 +82,12 @@ loadScripts(document, 'script');</script>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">TreeSpecies</span>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public enum </span><span class="element-name type-name-label">TreeSpecies</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&gt;</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Deprecated, see usage methods for replacement(s)</div>
</div>
<div class="block">Represents the different species of trees regardless of size.</div>
</section>
<section class="summary">
@ -107,26 +111,32 @@ loadScripts(document, 'script');</script>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="#ACACIA" class="member-name-link">ACACIA</a></code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents acacia trees.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#BIRCH" class="member-name-link">BIRCH</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents birches.</div>
</div>
<div class="col-first even-row-color"><code><a href="#DARK_OAK" class="member-name-link">DARK_OAK</a></code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents dark oak trees.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#GENERIC" class="member-name-link">GENERIC</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents the common tree species.</div>
</div>
<div class="col-first even-row-color"><code><a href="#JUNGLE" class="member-name-link">JUNGLE</a></code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents jungle trees.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#REDWOOD" class="member-name-link">REDWOOD</a></code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents the darker barked/leaved tree species.</div>
</div>
</div>
@ -157,14 +167,16 @@ loadScripts(document, 'script');</script>
<div class="deprecation-comment">Magic value</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</div>
@ -192,6 +204,7 @@ the order they are declared.</div>
<section class="detail" id="GENERIC">
<h3>GENERIC</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">GENERIC</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents the common tree species.</div>
</section>
</li>
@ -199,6 +212,7 @@ the order they are declared.</div>
<section class="detail" id="REDWOOD">
<h3>REDWOOD</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">REDWOOD</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents the darker barked/leaved tree species.</div>
</section>
</li>
@ -206,6 +220,7 @@ the order they are declared.</div>
<section class="detail" id="BIRCH">
<h3>BIRCH</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">BIRCH</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents birches.</div>
</section>
</li>
@ -213,6 +228,7 @@ the order they are declared.</div>
<section class="detail" id="JUNGLE">
<h3>JUNGLE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">JUNGLE</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents jungle trees.</div>
</section>
</li>
@ -220,6 +236,7 @@ the order they are declared.</div>
<section class="detail" id="ACACIA">
<h3>ACACIA</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">ACACIA</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents acacia trees.</div>
</section>
</li>
@ -227,6 +244,7 @@ the order they are declared.</div>
<section class="detail" id="DARK_OAK">
<h3>DARK_OAK</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">DARK_OAK</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Represents dark oak trees.</div>
</section>
</li>
@ -242,6 +260,7 @@ the order they are declared.</div>
<section class="detail" id="values()">
<h3>values</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
<dl class="notes">
@ -254,6 +273,7 @@ the order they are declared.</div>
<section class="detail" id="valueOf(java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the enum constant of this class with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this class. (Extraneous whitespace characters are