From 32022e9764123c6a8191a6496403cffc5c1fcc48 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Sun, 17 Dec 2017 00:01:03 +0100 Subject: [PATCH] Fix javadoc in org.eclipse.jgit.archive Change-Id: Ibef80b15f17e884f3085e324283cefc738236a4d Signed-off-by: Matthias Sohn --- .../org/eclipse/jgit/archive/ArchiveFormats.java | 8 ++++---- .../org/eclipse/jgit/archive/FormatActivator.java | 10 ++++------ .../src/org/eclipse/jgit/archive/TarFormat.java | 13 +++++++------ .../src/org/eclipse/jgit/archive/Tbz2Format.java | 13 +++++++------ .../src/org/eclipse/jgit/archive/TgzFormat.java | 13 +++++++------ .../src/org/eclipse/jgit/archive/TxzFormat.java | 13 +++++++------ .../src/org/eclipse/jgit/archive/ZipFormat.java | 13 +++++++------ .../eclipse/jgit/archive/internal/ArchiveText.java | 2 ++ 8 files changed, 45 insertions(+), 40 deletions(-) diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ArchiveFormats.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ArchiveFormats.java index 9d3decd93..bf0d88ee5 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ArchiveFormats.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ArchiveFormats.java @@ -48,11 +48,11 @@ import org.eclipse.jgit.api.ArchiveCommand; /** - * Registers all format types from the org.eclipse.jgit.archive - * package for use via the ArchiveCommand API. + * Registers all format types from the org.eclipse.jgit.archive package for use + * via the ArchiveCommand API. * - * See {@link FormatActivator} for an OSGi bundle activator - * that performs the same registration automatically. + * See {@link org.eclipse.jgit.archive.FormatActivator} for an OSGi bundle + * activator that performs the same registration automatically. */ public class ArchiveFormats { private static final List myFormats = new ArrayList<>(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java index aa4e4f500..0bb595a22 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/FormatActivator.java @@ -57,12 +57,11 @@ */ public class FormatActivator implements BundleActivator { /** + * {@inheritDoc} + * * Registers all included archive formats by calling * {@link ArchiveFormats#registerAll()}. This method is called by the OSGi * framework when the bundle is started. - * - * @param context - * unused */ @Override public void start(BundleContext context) { @@ -70,11 +69,10 @@ public void start(BundleContext context) { } /** + * {@inheritDoc} + * * Cleans up after {@link #start(BundleContext)} by calling * {@link ArchiveFormats#unregisterAll}. - * - * @param context - * unused */ @Override public void stop(BundleContext context) { diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java index 7b7fbcd83..7559ada86 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TarFormat.java @@ -70,6 +70,7 @@ public final class TarFormat extends BaseFormat implements private static final List SUFFIXES = Collections .unmodifiableList(Arrays.asList(".tar")); //$NON-NLS-1$ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s) throws IOException { @@ -77,9 +78,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s) Collections. emptyMap()); } - /** - * @since 4.0 - */ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s, Map o) throws IOException { @@ -89,6 +88,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s, return applyFormatOptions(out, o); } + /** {@inheritDoc} */ @Deprecated @Override public void putEntry(ArchiveOutputStream out, @@ -97,9 +97,7 @@ public void putEntry(ArchiveOutputStream out, putEntry(out, null, path, mode,loader); } - /** - * @since 4.7 - */ + /** {@inheritDoc} */ @Override public void putEntry(ArchiveOutputStream out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) @@ -150,16 +148,19 @@ public void putEntry(ArchiveOutputStream out, out.closeArchiveEntry(); } + /** {@inheritDoc} */ @Override public Iterable suffixes() { return SUFFIXES; } + /** {@inheritDoc} */ @Override public boolean equals(Object other) { return (other instanceof TarFormat); } + /** {@inheritDoc} */ @Override public int hashCode() { return getClass().hashCode(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java index 5f194ecdf..2f95f6d74 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/Tbz2Format.java @@ -66,6 +66,7 @@ public final class Tbz2Format extends BaseFormat implements private final ArchiveCommand.Format tarFormat = new TarFormat(); + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s) throws IOException { @@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s) Collections. emptyMap()); } - /** - * @since 4.0 - */ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s, Map o) throws IOException { @@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s, return tarFormat.createArchiveOutputStream(out, o); } + /** {@inheritDoc} */ @Deprecated @Override public void putEntry(ArchiveOutputStream out, @@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out, putEntry(out, null, path, mode,loader); } - /** - * @since 4.7 - */ + /** {@inheritDoc} */ @Override public void putEntry(ArchiveOutputStream out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) @@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out, tarFormat.putEntry(out, tree, path, mode, loader); } + /** {@inheritDoc} */ @Override public Iterable suffixes() { return SUFFIXES; } + /** {@inheritDoc} */ @Override public boolean equals(Object other) { return (other instanceof Tbz2Format); } + /** {@inheritDoc} */ @Override public int hashCode() { return getClass().hashCode(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java index a6d053e28..b22a62d07 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TgzFormat.java @@ -66,6 +66,7 @@ public final class TgzFormat extends BaseFormat implements private final ArchiveCommand.Format tarFormat = new TarFormat(); + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s) throws IOException { @@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s) Collections. emptyMap()); } - /** - * @since 4.0 - */ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s, Map o) throws IOException { @@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s, return tarFormat.createArchiveOutputStream(out, o); } + /** {@inheritDoc} */ @Deprecated @Override public void putEntry(ArchiveOutputStream out, @@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out, putEntry(out, null, path, mode,loader); } - /** - * @since 4.7 - */ + /** {@inheritDoc} */ @Override public void putEntry(ArchiveOutputStream out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) @@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out, tarFormat.putEntry(out, tree, path, mode, loader); } + /** {@inheritDoc} */ @Override public Iterable suffixes() { return SUFFIXES; } + /** {@inheritDoc} */ @Override public boolean equals(Object other) { return (other instanceof TgzFormat); } + /** {@inheritDoc} */ @Override public int hashCode() { return getClass().hashCode(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java index b6742acb9..d23d2b657 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/TxzFormat.java @@ -66,6 +66,7 @@ public final class TxzFormat extends BaseFormat implements private final ArchiveCommand.Format tarFormat = new TarFormat(); + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s) throws IOException { @@ -73,9 +74,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s) Collections. emptyMap()); } - /** - * @since 4.0 - */ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s, Map o) throws IOException { @@ -83,6 +82,7 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s, return tarFormat.createArchiveOutputStream(out, o); } + /** {@inheritDoc} */ @Deprecated @Override public void putEntry(ArchiveOutputStream out, @@ -91,9 +91,7 @@ public void putEntry(ArchiveOutputStream out, putEntry(out, null, path, mode,loader); } - /** - * @since 4.7 - */ + /** {@inheritDoc} */ @Override public void putEntry(ArchiveOutputStream out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) @@ -101,16 +99,19 @@ public void putEntry(ArchiveOutputStream out, tarFormat.putEntry(out, tree, path, mode, loader); } + /** {@inheritDoc} */ @Override public Iterable suffixes() { return SUFFIXES; } + /** {@inheritDoc} */ @Override public boolean equals(Object other) { return (other instanceof TxzFormat); } + /** {@inheritDoc} */ @Override public int hashCode() { return getClass().hashCode(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java index 46d918ed7..dc8fb4457 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/ZipFormat.java @@ -68,6 +68,7 @@ public final class ZipFormat extends BaseFormat implements private static final List SUFFIXES = Collections .unmodifiableList(Arrays.asList(".zip")); //$NON-NLS-1$ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s) throws IOException { @@ -75,15 +76,14 @@ public ArchiveOutputStream createArchiveOutputStream(OutputStream s) Collections. emptyMap()); } - /** - * @since 4.0 - */ + /** {@inheritDoc} */ @Override public ArchiveOutputStream createArchiveOutputStream(OutputStream s, Map o) throws IOException { return applyFormatOptions(new ZipArchiveOutputStream(s), o); } + /** {@inheritDoc} */ @Deprecated @Override public void putEntry(ArchiveOutputStream out, @@ -92,9 +92,7 @@ public void putEntry(ArchiveOutputStream out, putEntry(out, null, path, mode,loader); } - /** - * @since 4.7 - */ + /** {@inheritDoc} */ @Override public void putEntry(ArchiveOutputStream out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) @@ -136,16 +134,19 @@ public void putEntry(ArchiveOutputStream out, out.closeArchiveEntry(); } + /** {@inheritDoc} */ @Override public Iterable suffixes() { return SUFFIXES; } + /** {@inheritDoc} */ @Override public boolean equals(Object other) { return (other instanceof ZipFormat); } + /** {@inheritDoc} */ @Override public int hashCode() { return getClass().hashCode(); diff --git a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/internal/ArchiveText.java b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/internal/ArchiveText.java index f631cf8ec..cac491a0f 100644 --- a/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/internal/ArchiveText.java +++ b/org.eclipse.jgit.archive/src/org/eclipse/jgit/archive/internal/ArchiveText.java @@ -51,6 +51,8 @@ */ public class ArchiveText extends TranslationBundle { /** + * Get an instance of this translation bundle. + * * @return an instance of this translation bundle */ public static ArchiveText get() {