From 05a7113002063b80cf48591594c7e01cd2111ec6 Mon Sep 17 00:00:00 2001 From: Matthias Sohn Date: Fri, 16 Nov 2012 02:04:58 +0100 Subject: [PATCH] Add missing @since tags to mark API added in 2.2 Change-Id: I458167739210214fa54c4b3d62fac5abc82f96f7 Signed-off-by: Matthias Sohn Signed-off-by: Chris Aniszczyk --- .../src/org/eclipse/jgit/pgm/CLIText.java | 1 + .../src/org/eclipse/jgit/pgm/TextBuiltin.java | 12 ++++++++++-- .../src/org/eclipse/jgit/dircache/DirCacheEntry.java | 1 + .../dfs/BeforeDfsPackIndexLoadedListener.java | 6 +++++- .../org/eclipse/jgit/storage/dfs/DfsPackFile.java | 5 ++++- .../src/org/eclipse/jgit/util/RawParseUtils.java | 2 ++ .../eclipse/jgit/util/io/ThrowingPrintWriter.java | 2 ++ 7 files changed, 25 insertions(+), 4 deletions(-) diff --git a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CLIText.java b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CLIText.java index 5a0b8b2875..b784c37bd2 100644 --- a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CLIText.java +++ b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CLIText.java @@ -67,6 +67,7 @@ public class CLIText extends TranslationBundle { * @param line * the line to format * @return the formatted line + * @since 2.2 */ public static String formatLine(String line) { return MessageFormat.format(get().lineFormat, line); diff --git a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/TextBuiltin.java b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/TextBuiltin.java index fe8907bc20..87437107d8 100644 --- a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/TextBuiltin.java +++ b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/TextBuiltin.java @@ -83,10 +83,18 @@ public abstract class TextBuiltin { @Option(name = "--help", usage = "usage_displayThisHelpText", aliases = { "-h" }) private boolean help; - /** Writer to output to, typically this is standard output. */ + /** + * Writer to output to, typically this is standard output. + * + * @since 2.2 + */ protected ThrowingPrintWriter outw; - /** Stream to output to, typically this is standard output. */ + /** + * Stream to output to, typically this is standard output. + * + * @since 2.2 + */ protected OutputStream outs; /** diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheEntry.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheEntry.java index 0b269b0d7c..95bc1129c3 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheEntry.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheEntry.java @@ -450,6 +450,7 @@ public class DirCacheEntry { * Returns whether this entry is in the fully-merged stage (0). * * @return true if this entry is merged + * @since 2.2 */ public boolean isMerged() { return getStage() == STAGE_0; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/BeforeDfsPackIndexLoadedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/BeforeDfsPackIndexLoadedListener.java index e0ddf4138f..ab9dd42820 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/BeforeDfsPackIndexLoadedListener.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/BeforeDfsPackIndexLoadedListener.java @@ -45,7 +45,11 @@ package org.eclipse.jgit.storage.dfs; import org.eclipse.jgit.events.RepositoryListener; -/** Receives {@link BeforeDfsPackIndexLoadedEvent}s. */ +/** + * Receives {@link BeforeDfsPackIndexLoadedEvent}s. + * + * @since 2.2 + */ public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener { /** * Invoked just before a pack index is loaded from the block cache. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsPackFile.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsPackFile.java index 3dabb9fc74..ea8aa73cf0 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsPackFile.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/DfsPackFile.java @@ -172,7 +172,10 @@ public final class DfsPackFile { return packDesc; } - /** @return whether the pack index file is loaded and cached in memory. */ + /** + * @return whether the pack index file is loaded and cached in memory. + * @since 2.2 + */ public boolean isIndexLoaded() { DfsBlockCache.Ref idxref = index; return idxref != null && idxref.get() != null; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java index 89fbeed890..c20474d11c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java @@ -67,6 +67,8 @@ import org.eclipse.jgit.lib.PersonIdent; public final class RawParseUtils { /** * UTF-8 charset constant. + * + * @since 2.2 */ public static final Charset UTF8_CHARSET = Charset.forName("UTF-8"); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/ThrowingPrintWriter.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/ThrowingPrintWriter.java index 1c5c2b6b48..e4a8fc080e 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/ThrowingPrintWriter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/ThrowingPrintWriter.java @@ -51,6 +51,8 @@ import org.eclipse.jgit.util.SystemReader; /** * An alternative PrintWriter that doesn't catch exceptions. + * + * @since 2.2 */ public class ThrowingPrintWriter extends Writer { -- 2.39.5