Merge pull request #322 from dmlloyd/javadoc-problems

Fix Javadoc problems
smallrye · Jul 1, 2024 · 01f5e20 · 01f5e20
2 parents 1cc4d06 + 2fbbca2
commit 01f5e20
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 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
@@ -13,6 +13,9 @@ public final class EmptyDirectoryStream<T> implements DirectoryStream<T> {
     private EmptyDirectoryStream() {
     }
 
+    /**
+     * {@return the singleton instance}
+     */
     @SuppressWarnings("unchecked")
     public static <T> EmptyDirectoryStream<T> instance() {
         return (EmptyDirectoryStream<T>) 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
@@ -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
@@ -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
      */