From: Ivan Frade <ifrade@google.com>
Date: Wed, 30 Oct 2024 22:36:09 +0000 (-0700)
Subject: [errorprone] PackWriter: Fix javadoc tag in new #writeIndex method
X-Git-Tag: v7.1.0.202411121450-m3~1^2~19^2
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c9752b0125c84248c468065eba64bf007abae81c;p=jgit.git

[errorprone] PackWriter: Fix javadoc tag in new #writeIndex method

We introduced this method recently and the javadoc is not correct:

error: [InvalidInlineTag] This tag is invalid.
   @code{PackIndexWriter} instance to write the index

Change-Id: I34ed3d8b5a121fea9b8163627b46ae4a289c9462
---

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java
index 4c262b0e3a..f025d4e3d5 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java
@@ -59,9 +59,9 @@ import org.eclipse.jgit.errors.SearchForReuseTimeout;
 import org.eclipse.jgit.errors.StoredObjectRepresentationNotAvailableException;
 import org.eclipse.jgit.internal.JGitText;
 import org.eclipse.jgit.internal.storage.file.BasePackIndexWriter;
+import org.eclipse.jgit.internal.storage.file.PackBitmapIndexBuilder;
 import org.eclipse.jgit.internal.storage.file.PackObjectSizeIndexWriter;
 import org.eclipse.jgit.internal.storage.file.PackReverseIndexWriter;
-import org.eclipse.jgit.internal.storage.file.PackBitmapIndexBuilder;
 import org.eclipse.jgit.lib.AnyObjectId;
 import org.eclipse.jgit.lib.AsyncObjectSizeQueue;
 import org.eclipse.jgit.lib.BatchingProgressMonitor;
@@ -1113,7 +1113,7 @@ public class PackWriter implements AutoCloseable {
 	 * the network do not need to create an index.
 	 *
 	 * @param iw
-	 *            an @code{PackIndexWriter} instance to write the index
+	 *            an {@link PackIndexWriter} instance to write the index
 	 * @throws java.io.IOException
 	 *             the index data could not be written to the supplied stream.
 	 */