From 99f480765cb31ba2d56227e965e44f3781cdbc87 Mon Sep 17 00:00:00 2001 From: Dan Mulloy Date: Sun, 9 Apr 2023 19:02:14 -0500 Subject: [PATCH] fix some javadocs --- build.gradle | 19 ++++++++++++++----- .../protocol/events/PacketOutputHandler.java | 2 +- .../protocol/wrappers/EnumWrappers.java | 6 +++--- .../protocol/wrappers/WrappedDataWatcher.java | 4 ++-- .../wrappers/collection/ConvertedMap.java | 8 ++++---- .../collection/ConvertedMultimap.java | 8 ++++---- .../comphenix/protocol/PacketTypeTest.java | 2 +- 7 files changed, 29 insertions(+), 20 deletions(-) diff --git a/build.gradle b/build.gradle index 712bfb48..67cac9c5 100644 --- a/build.gradle +++ b/build.gradle @@ -1,17 +1,18 @@ plugins { - id 'com.github.johnrengelman.shadow' version '8.1.1' id 'java-library' id 'maven-publish' + id 'com.github.johnrengelman.shadow' version '8.1.1' } group = 'com.comphenix.protocol' version = '5.0.0-SNAPSHOT' -description = 'ProtocolLib' -java.sourceCompatibility = JavaVersion.VERSION_17 -java.targetCompatibility = JavaVersion.VERSION_17 +description = 'Provides access to the Minecraft protocol' + +// java.sourceCompatibility = JavaVersion.VERSION_17 +// java.targetCompatibility = JavaVersion.VERSION_17 repositories { - // mavenLocal() + mavenLocal() mavenCentral() maven { @@ -41,6 +42,14 @@ dependencies { implementation 'com.googlecode.json-simple:json-simple:1.1.1' } +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 + + withJavadocJar() + withSourcesJar() +} + shadowJar { dependencies { include(dependency('net.bytebuddy:byte-buddy:.*')) diff --git a/src/main/java/com/comphenix/protocol/events/PacketOutputHandler.java b/src/main/java/com/comphenix/protocol/events/PacketOutputHandler.java index 4e8f86b2..739336f0 100644 --- a/src/main/java/com/comphenix/protocol/events/PacketOutputHandler.java +++ b/src/main/java/com/comphenix/protocol/events/PacketOutputHandler.java @@ -28,7 +28,7 @@ public interface PacketOutputHandler { * Note that the buffer is initially filled with the output from the default write method. *

* 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 buffer - the data that is currently scheduled to be outputted. * @return The modified byte array to write. NULL is not permitted. diff --git a/src/main/java/com/comphenix/protocol/wrappers/EnumWrappers.java b/src/main/java/com/comphenix/protocol/wrappers/EnumWrappers.java index e0f99629..08139233 100644 --- a/src/main/java/com/comphenix/protocol/wrappers/EnumWrappers.java +++ b/src/main/java/com/comphenix/protocol/wrappers/EnumWrappers.java @@ -378,9 +378,9 @@ public abstract class EnumWrappers { /** * Wrapped EntityPose enum for use in Entity Metadata Packet.
- * - * @apiNote Remember to use {@link #toNms()} when adding to a {@link WrappedDataWatcher}.
- * Serializer is obtained using Registry.get(EnumWrappers.getEntityPoseClass()) + * Remember to use {@link #toNms()} when adding to a {@link WrappedDataWatcher}.
+ * Serializer is obtained using Registry.get(EnumWrappers.getEntityPoseClass()) + * * @since 1.13 * @author Lewys Davies (Lew_) */ diff --git a/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java b/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java index 89b6465a..b30c2476 100644 --- a/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java +++ b/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java @@ -941,8 +941,8 @@ public class WrappedDataWatcher extends AbstractWrapper implements IterableNote: If the serializer is optional, values must be + *
+ * Note: If the serializer is optional, values must be * wrapped in an {@link Optional} * * @param clazz Class to find serializer for diff --git a/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMap.java b/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMap.java index 56e796b6..c1b1800a 100644 --- a/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMap.java +++ b/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMap.java @@ -136,10 +136,10 @@ public abstract class ConvertedMap extends AbstractConverte /** * Returns a string representation of this map. The string representation * consists of a list of key-value mappings in the order returned by the - * map's entrySet view's iterator, enclosed in braces - * ("{}"). Adjacent mappings are separated by the characters - * ", " (comma and space). Each key-value mapping is rendered as - * the key followed by an equals sign ("=") followed by the + * map's entrySet view's iterator, enclosed in braces + * ("{}"). Adjacent mappings are separated by the characters + * ", " (comma and space). Each key-value mapping is rendered as + * the key followed by an equals sign ("=") followed by the * associated value. Keys and values are converted to strings as by * {@link String#valueOf(Object)}. * diff --git a/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMultimap.java b/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMultimap.java index ab5e03be..5000b1ba 100644 --- a/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMultimap.java +++ b/src/main/java/com/comphenix/protocol/wrappers/collection/ConvertedMultimap.java @@ -204,10 +204,10 @@ public abstract class ConvertedMultimap extends AbstractCon /** * Returns a string representation of this map. The string representation * consists of a list of key-value mappings in the order returned by the - * map's entrySet view's iterator, enclosed in braces - * ("{}"). Adjacent mappings are separated by the characters - * ", " (comma and space). Each key-value mapping is rendered as - * the key followed by an equals sign ("=") followed by the + * map's entrySet view's iterator, enclosed in braces + * ("{}"). Adjacent mappings are separated by the characters + * ", " (comma and space). Each key-value mapping is rendered as + * the key followed by an equals sign ("=") followed by the * associated value. Keys and values are converted to strings as by * {@link String#valueOf(Object)}. * diff --git a/src/test/java/com/comphenix/protocol/PacketTypeTest.java b/src/test/java/com/comphenix/protocol/PacketTypeTest.java index dfb80d3b..6f53a60b 100644 --- a/src/test/java/com/comphenix/protocol/PacketTypeTest.java +++ b/src/test/java/com/comphenix/protocol/PacketTypeTest.java @@ -328,7 +328,7 @@ public class PacketTypeTest { if (ex.getMessage().contains("BundleDelimiterPacket")) { continue; } - + ex.printStackTrace(); fail = true; }