fix some javadocs

This commit is contained in:
Dan Mulloy 2023-04-09 19:02:14 -05:00
parent 327a17ba50
commit 99f480765c
No known key found for this signature in database
GPG Key ID: F379C293F178751F
7 changed files with 29 additions and 20 deletions

View File

@ -1,17 +1,18 @@
plugins { plugins {
id 'com.github.johnrengelman.shadow' version '8.1.1'
id 'java-library' id 'java-library'
id 'maven-publish' id 'maven-publish'
id 'com.github.johnrengelman.shadow' version '8.1.1'
} }
group = 'com.comphenix.protocol' group = 'com.comphenix.protocol'
version = '5.0.0-SNAPSHOT' version = '5.0.0-SNAPSHOT'
description = 'ProtocolLib' description = 'Provides access to the Minecraft protocol'
java.sourceCompatibility = JavaVersion.VERSION_17
java.targetCompatibility = JavaVersion.VERSION_17 // java.sourceCompatibility = JavaVersion.VERSION_17
// java.targetCompatibility = JavaVersion.VERSION_17
repositories { repositories {
// mavenLocal() mavenLocal()
mavenCentral() mavenCentral()
maven { maven {
@ -41,6 +42,14 @@ dependencies {
implementation 'com.googlecode.json-simple:json-simple:1.1.1' implementation 'com.googlecode.json-simple:json-simple:1.1.1'
} }
java {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
withJavadocJar()
withSourcesJar()
}
shadowJar { shadowJar {
dependencies { dependencies {
include(dependency('net.bytebuddy:byte-buddy:.*')) include(dependency('net.bytebuddy:byte-buddy:.*'))

View File

@ -28,7 +28,7 @@ public interface PacketOutputHandler {
* Note that the buffer is initially filled with the output from the default write method. * Note that the buffer is initially filled with the output from the default write method.
* <p> * <p>
* In Minecraft 1.6.4, the header is always excluded, whereas it MUST be included in Minecraft 1.7.2. Call * In Minecraft 1.6.4, the header is always excluded, whereas it MUST be included in Minecraft 1.7.2. Call
* {@link NetworkMarker#requireOutputHeader()} to determine this. * NetworkMarker#requireOutputHeader() to determine this.
* @param event - the packet that will be outputted. * @param event - the packet that will be outputted.
* @param buffer - the data that is currently scheduled to be outputted. * @param buffer - the data that is currently scheduled to be outputted.
* @return The modified byte array to write. NULL is not permitted. * @return The modified byte array to write. NULL is not permitted.

View File

@ -378,9 +378,9 @@ public abstract class EnumWrappers {
/** /**
* Wrapped EntityPose enum for use in Entity Metadata Packet.<br> * Wrapped EntityPose enum for use in Entity Metadata Packet.<br>
* * Remember to use {@link #toNms()} when adding to a {@link WrappedDataWatcher}. <br>
* @apiNote Remember to use {@link #toNms()} when adding to a {@link WrappedDataWatcher}. <br>
* Serializer is obtained using Registry.get(EnumWrappers.getEntityPoseClass()) * Serializer is obtained using Registry.get(EnumWrappers.getEntityPoseClass())
*
* @since 1.13 * @since 1.13
* @author Lewys Davies (Lew_) * @author Lewys Davies (Lew_)
*/ */

View File

@ -941,8 +941,8 @@ public class WrappedDataWatcher extends AbstractWrapper implements Iterable<Wrap
/** /**
* Gets the first serializer associated with a given class and optional state. * Gets the first serializer associated with a given class and optional state.
* * <br/>
* <p><b>Note</b>: If the serializer is optional, values <i>must<i> be * <b>Note</b>: If the serializer is optional, values <i>must</i> be
* wrapped in an {@link Optional} * wrapped in an {@link Optional}
* *
* @param clazz Class to find serializer for * @param clazz Class to find serializer for

View File

@ -136,10 +136,10 @@ public abstract class ConvertedMap<Key, VInner, VOuter> extends AbstractConverte
/** /**
* Returns a string representation of this map. The string representation * Returns a string representation of this map. The string representation
* consists of a list of key-value mappings in the order returned by the * consists of a list of key-value mappings in the order returned by the
* map's <tt>entrySet</tt> view's iterator, enclosed in braces * map's <code>entrySet</code> view's iterator, enclosed in braces
* (<tt>"{}"</tt>). Adjacent mappings are separated by the characters * (<code>"{}"</code>). Adjacent mappings are separated by the characters
* <tt>", "</tt> (comma and space). Each key-value mapping is rendered as * <code>", "</code> (comma and space). Each key-value mapping is rendered as
* the key followed by an equals sign (<tt>"="</tt>) followed by the * the key followed by an equals sign (<code>"="</code>) followed by the
* associated value. Keys and values are converted to strings as by * associated value. Keys and values are converted to strings as by
* {@link String#valueOf(Object)}. * {@link String#valueOf(Object)}.
* *

View File

@ -204,10 +204,10 @@ public abstract class ConvertedMultimap<Key, VInner, VOuter> extends AbstractCon
/** /**
* Returns a string representation of this map. The string representation * Returns a string representation of this map. The string representation
* consists of a list of key-value mappings in the order returned by the * consists of a list of key-value mappings in the order returned by the
* map's <tt>entrySet</tt> view's iterator, enclosed in braces * map's <code>entrySet</code> view's iterator, enclosed in braces
* (<tt>"{}"</tt>). Adjacent mappings are separated by the characters * (<code>"{}"</code>). Adjacent mappings are separated by the characters
* <tt>", "</tt> (comma and space). Each key-value mapping is rendered as * <code>", "</code> (comma and space). Each key-value mapping is rendered as
* the key followed by an equals sign (<tt>"="</tt>) followed by the * the key followed by an equals sign (<code>"="</code>) followed by the
* associated value. Keys and values are converted to strings as by * associated value. Keys and values are converted to strings as by
* {@link String#valueOf(Object)}. * {@link String#valueOf(Object)}.
* *