From 2fbbca2b9be2f4cf6183f251f3d3ffc64997bc7c Mon Sep 17 00:00:00 2001 From: "David M. Lloyd" Date: Mon, 1 Jul 2024 14:14:54 -0500 Subject: [PATCH] Fix Javadoc problems --- .../io/smallrye/common/resource/EmptyDirectoryStream.java | 3 +++ .../main/java/io/smallrye/common/resource/MemoryResource.java | 4 ++-- .../src/main/java/io/smallrye/common/resource/Resource.java | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/resource/src/main/java/io/smallrye/common/resource/EmptyDirectoryStream.java b/resource/src/main/java/io/smallrye/common/resource/EmptyDirectoryStream.java index 5a7882c..8868ace 100644 --- a/resource/src/main/java/io/smallrye/common/resource/EmptyDirectoryStream.java +++ b/resource/src/main/java/io/smallrye/common/resource/EmptyDirectoryStream.java @@ -13,6 +13,9 @@ public final class EmptyDirectoryStream implements DirectoryStream { private EmptyDirectoryStream() { } + /** + * {@return the singleton instance} + */ @SuppressWarnings("unchecked") public static EmptyDirectoryStream instance() { return (EmptyDirectoryStream) INSTANCE; diff --git a/resource/src/main/java/io/smallrye/common/resource/MemoryResource.java b/resource/src/main/java/io/smallrye/common/resource/MemoryResource.java index 3b309cb..6e2ba22 100644 --- a/resource/src/main/java/io/smallrye/common/resource/MemoryResource.java +++ b/resource/src/main/java/io/smallrye/common/resource/MemoryResource.java @@ -32,8 +32,8 @@ public final class MemoryResource extends Resource { * Accessing the resource will not affect the buffer's position or limit. * Modifying the buffer's position or limit will not affect the contents of the resource. * - * @param buffer the byte buffer containing the resource data (must not be {@code null}) * @param pathName the resource path name (must not be {@code null}) + * @param data the byte buffer containing the resource data (must not be {@code null}) */ public MemoryResource(final String pathName, final ByteBuffer data) { super(pathName); @@ -44,8 +44,8 @@ public MemoryResource(final String pathName, final ByteBuffer data) { * Construct a new instance for a byte array. * The byte array is not copied. * - * @param bytes the byte array (must not be {@code null}) * @param pathName the resource path name (must not be {@code null}) + * @param data the byte array (must not be {@code null}) */ public MemoryResource(final String pathName, final byte[] data) { this(pathName, ByteBuffer.wrap(data)); diff --git a/resource/src/main/java/io/smallrye/common/resource/Resource.java b/resource/src/main/java/io/smallrye/common/resource/Resource.java index 2717b23..30691c9 100644 --- a/resource/src/main/java/io/smallrye/common/resource/Resource.java +++ b/resource/src/main/java/io/smallrye/common/resource/Resource.java @@ -160,7 +160,7 @@ public long copyTo(OutputStream destination) throws IOException { * in this case the content and state of the destination are undefined. * The destination channel is not closed. * - * @param destination the destination channel (must not be {@code null} and must not be non-blocking) + * @param channel the destination channel (must not be {@code null} and must not be non-blocking) * @return the number of bytes copied * @throws IOException if the copy fails */