From 10316f910f43e6ea2a5a7c2f11320ce0efd798a5 Mon Sep 17 00:00:00 2001
From: Matt Benson <mbenson@apache.org>
Date: Sun, 13 Feb 2022 11:49:19 -0600
Subject: [PATCH] Address some Javadoc issues

---
 src/main/org/apache/tools/zip/ZipEntry.java   | 22 +++++++++++--------
 .../org/apache/tools/zip/ZipOutputStream.java |  6 +++--
 2 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/src/main/org/apache/tools/zip/ZipEntry.java b/src/main/org/apache/tools/zip/ZipEntry.java
index e90d5ff31..a1afbdaea 100644
--- a/src/main/org/apache/tools/zip/ZipEntry.java
+++ b/src/main/org/apache/tools/zip/ZipEntry.java
@@ -169,7 +169,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
     }
 
     /**
-     * Overwrite clone.
+     * Override clone.
      *
      * @return a cloned copy of this ZipEntry
      * @since 1.1
@@ -486,7 +486,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
      * Looks up an extra field by its header id.
      *
      * @param type ZipShort
-     * @return null if no such field exists.
+     * @return {@code null} if no such field exists.
      */
     public ZipExtraField getExtraField(final ZipShort type) {
         if (extraFields != null) {
@@ -502,7 +502,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
     /**
      * Looks up extra field data that couldn't be parsed correctly.
      *
-     * @return null if no such field exists.
+     * @return {@code null} if no such field exists.
      */
     public UnparseableExtraFieldData getUnparseableExtraFieldData() {
         return unparseableExtra;
@@ -546,7 +546,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
     /**
      * Sets the central directory part of extra fields.
      *
-     * @param b boolean
+     * @param b {@code boolean}
      */
     public void setCentralDirectoryExtra(final byte[] b) {
         try {
@@ -587,7 +587,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
      *
      * @param size the size to use
      * @deprecated since 1.7.
-     *             Use setCompressedSize directly.
+     *             Use {@link #setCompressedSize(long)} directly.
      * @since 1.2
      */
     @Deprecated
@@ -609,7 +609,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
     /**
      * Is this entry a directory?
      *
-     * @return true if the entry is a directory
+     * @return {@code true} if the entry is a directory
      * @since 1.10
      */
     @Override
@@ -759,13 +759,17 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
         }
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Get last modified time as {@link Date}.
+     *
+     * @return {@link Date}
+     */
     public Date getLastModifiedDate() {
         return new Date(getTime());
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Object#equals(java.lang.Object)
+    /**
+     * {@inheritDoc}
      */
     @Override
     public boolean equals(final Object obj) {
diff --git a/src/main/org/apache/tools/zip/ZipOutputStream.java b/src/main/org/apache/tools/zip/ZipOutputStream.java
index a2d44edaf..9e216d8ca 100644
--- a/src/main/org/apache/tools/zip/ZipOutputStream.java
+++ b/src/main/org/apache/tools/zip/ZipOutputStream.java
@@ -495,7 +495,8 @@ public class ZipOutputStream extends FilterOutputStream {
     }
 
     /**
-     * {@inheritDoc}
+     * Finish writing the archive.
+     *
      * @throws Zip64RequiredException if the archive's size exceeds 4
      * GByte or there are more than 65535 entries inside the archive
      * and {@link #setUseZip64} is {@link Zip64Mode#Never}.
@@ -728,7 +729,8 @@ public class ZipOutputStream extends FilterOutputStream {
     }
 
     /**
-     * {@inheritDoc}
+     * Put the specified entry into the archive.
+     *
      * @throws Zip64RequiredException if the entry's uncompressed or
      * compressed size is known to exceed 4 GByte and {@link #setUseZip64}
      * is {@link Zip64Mode#Never}.