From 061d24f6d557b7bdfdf530c7a50f66d7bf422c07 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Tue, 24 Jan 2017 10:16:19 -0800 Subject: [PATCH] Remove @since tags from internal packages These packages don't use @since tags because they are not part of the stable public API. Some @since tags snuck in, though. Remove them to make the convention easier to find for new contributors and the expectations clearer for users. Change-Id: I6c17d3cfc93657f1b33cf5c5708f2b1c712b0d31 --- .../src/org/eclipse/jgit/pgm/internal/CLIText.java | 2 -- .../org/eclipse/jgit/ignore/internal/AbstractMatcher.java | 2 -- .../src/org/eclipse/jgit/ignore/internal/IMatcher.java | 2 -- .../jgit/ignore/internal/LeadingAsteriskMatcher.java | 2 -- .../src/org/eclipse/jgit/ignore/internal/NameMatcher.java | 2 -- .../src/org/eclipse/jgit/ignore/internal/PathMatcher.java | 2 -- .../src/org/eclipse/jgit/ignore/internal/Strings.java | 2 -- .../jgit/ignore/internal/TrailingAsteriskMatcher.java | 2 -- .../org/eclipse/jgit/ignore/internal/WildCardMatcher.java | 2 -- .../src/org/eclipse/jgit/ignore/internal/WildMatcher.java | 2 -- .../storage/dfs/BeforeDfsPackIndexLoadedListener.java | 2 -- .../jgit/internal/storage/dfs/DfsBlockCacheConfig.java | 4 ---- .../eclipse/jgit/internal/storage/dfs/DfsPackFile.java | 1 - .../jgit/internal/storage/dfs/DfsReaderOptions.java | 2 -- .../jgit/internal/storage/dfs/InMemoryRepository.java | 1 - .../src/org/eclipse/jgit/internal/storage/file/GC.java | 2 -- .../org/eclipse/jgit/internal/storage/file/LockFile.java | 1 - .../eclipse/jgit/internal/storage/file/ReflogWriter.java | 2 -- .../eclipse/jgit/internal/storage/pack/PackWriter.java | 8 -------- 19 files changed, 43 deletions(-) diff --git a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java index 90c03e99b..4842b9873 100644 --- a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java +++ b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java @@ -68,7 +68,6 @@ 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); @@ -81,7 +80,6 @@ public class CLIText extends TranslationBundle { * @param message * the message to format * @return the formatted line - * @since 4.2 */ public static String fatalError(String message) { return MessageFormat.format(get().fatalError, message); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java index 4e90d8c3c..64c2a7455 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java @@ -46,8 +46,6 @@ package org.eclipse.jgit.ignore.internal; * Base class for default methods as {@link #toString()} and such. *

* This class is immutable and thread safe. - * - * @since 3.6 */ public abstract class AbstractMatcher implements IMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java index 8bb4dfb56..4c13e2ff6 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java @@ -44,8 +44,6 @@ package org.eclipse.jgit.ignore.internal; /** * Generic string matcher - * - * @since 3.6 */ public interface IMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java index 3d0ad0912..3ebc6afb2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java @@ -44,8 +44,6 @@ package org.eclipse.jgit.ignore.internal; /** * Matcher for simple regex patterns starting with an asterisk, e.g. "*.tmp" - * - * @since 3.6 */ public class LeadingAsteriskMatcher extends NameMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java index 8beae8379..888b989b6 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java @@ -47,8 +47,6 @@ import static org.eclipse.jgit.ignore.internal.Strings.getPathSeparator; /** * Matcher built from patterns for file names (single path segments). This class * is immutable and thread safe. - * - * @since 3.6 */ public class NameMatcher extends AbstractMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java index c3f6694a7..adf13292b 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java @@ -59,8 +59,6 @@ import org.eclipse.jgit.ignore.internal.Strings.PatternState; * Matcher built by patterns consists of multiple path segments. *

* This class is immutable and thread safe. - * - * @since 3.6 */ public class PathMatcher extends AbstractMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java index 70c519903..1c467fe71 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java @@ -58,8 +58,6 @@ import org.eclipse.jgit.internal.JGitText; /** * Various {@link String} related utility methods, written mostly to avoid * generation of new String objects (e.g. via splitting Strings etc). - * - * @since 3.6 */ public class Strings { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java index b927d27db..c7064ac85 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java @@ -44,8 +44,6 @@ package org.eclipse.jgit.ignore.internal; /** * Matcher for simple patterns ending with an asterisk, e.g. "Makefile.*" - * - * @since 3.6 */ public class TrailingAsteriskMatcher extends NameMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java index 8f9815283..f64050f83 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java @@ -53,8 +53,6 @@ import org.eclipse.jgit.errors.InvalidPatternException; * glob wildcards to Java {@link Pattern}'s. *

* This class is immutable and thread safe. - * - * @since 3.6 */ public class WildCardMatcher extends NameMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java index d57865437..2f24e0241 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java @@ -47,8 +47,6 @@ package org.eclipse.jgit.ignore.internal; * matcher matches any path. *

* This class is immutable and thread safe. - * - * @since 3.6 */ public final class WildMatcher extends AbstractMatcher { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java index 047c86f28..9f7f35083 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java @@ -47,8 +47,6 @@ import org.eclipse.jgit.events.RepositoryListener; /** * Receives {@link BeforeDfsPackIndexLoadedEvent}s. - * - * @since 2.2 */ public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener { /** diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java index 089bfa471..feadedbc8 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java @@ -122,7 +122,6 @@ public class DfsBlockCacheConfig { /** * @return the estimated number of threads concurrently accessing the cache. * Default is 32. - * @since 4.6 */ public int getConcurrencyLevel() { return concurrencyLevel; @@ -133,7 +132,6 @@ public class DfsBlockCacheConfig { * the estimated number of threads concurrently accessing the * cache. * @return {@code this} - * @since 4.6 */ public DfsBlockCacheConfig setConcurrencyLevel( final int newConcurrencyLevel) { @@ -145,7 +143,6 @@ public class DfsBlockCacheConfig { * @return highest percentage of {@link #getBlockLimit()} a single pack can * occupy while being copied by the pack reuse strategy. Default * is 0.30, or 30%. - * @since 4.0 */ public double getStreamRatio() { return streamRatio; @@ -155,7 +152,6 @@ public class DfsBlockCacheConfig { * @param ratio * percentage of cache to occupy with a copied pack. * @return {@code this} - * @since 4.0 */ public DfsBlockCacheConfig setStreamRatio(double ratio) { streamRatio = Math.max(0, Math.min(ratio, 1.0)); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java index a3d79ecb6..f15d427f8 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java @@ -187,7 +187,6 @@ public final class DfsPackFile { /** * @return whether the pack index file is loaded and cached in memory. - * @since 2.2 */ public boolean isIndexLoaded() { DfsBlockCache.Ref idxref = index; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java index 84198077e..d07c13d0b 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java @@ -109,7 +109,6 @@ public class DfsReaderOptions { /** * @return number of bytes to use for buffering when streaming a pack file * during copying. If 0 the block size of the pack is used. - * @since 4.0 */ public int getStreamPackBufferSize() { return streamPackBufferSize; @@ -120,7 +119,6 @@ public class DfsReaderOptions { * new buffer size in bytes for buffers used when streaming pack * files during copying. * @return {@code this} - * @since 4.0 */ public DfsReaderOptions setStreamPackBufferSize(int bufsz) { streamPackBufferSize = Math.max(0, bufsz); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java index fd213977a..bdcf9f9a1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java @@ -63,7 +63,6 @@ public class InMemoryRepository extends DfsRepository { * * @param repoDesc * description of the repository. - * @since 2.0 */ public InMemoryRepository(DfsRepositoryDescription repoDesc) { this(new Builder().setRepositoryDescription(repoDesc)); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java index 32ea382a2..1caa35f13 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java @@ -1161,7 +1161,6 @@ public class GC { * influence how packs are written and to implement something similar to * "git gc --aggressive" * - * @since 3.6 * @param pconfig * the {@link PackConfig} used when writing packs */ @@ -1234,7 +1233,6 @@ public class GC { * * @param auto * defines whether gc should do automatic housekeeping - * @since 4.5 */ public void setAuto(boolean auto) { this.automatic = auto; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java index ce9677a62..fcc8d7178 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java @@ -150,7 +150,6 @@ public class LockFile { * * @param f * the file that will be locked. - * @since 4.2 */ public LockFile(final File f) { ref = f; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java index fc802666b..24d2c790e 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java @@ -74,8 +74,6 @@ import org.eclipse.jgit.util.FileUtils; /** * Utility for writing reflog entries - * - * @since 2.0 */ public class ReflogWriter { 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 a5764be4d..ffab1a746 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 @@ -369,7 +369,6 @@ public class PackWriter implements AutoCloseable { * the callback to set * * @return this object for chaining. - * @since 4.1 */ public PackWriter setObjectCountCallback(ObjectCountCallback callback) { this.callback = callback; @@ -381,7 +380,6 @@ public class PackWriter implements AutoCloseable { * * @param clientShallowCommits * the shallow commits in the client - * @since 4.1 */ public void setClientShallowCommits(Set clientShallowCommits) { stats.clientShallowCommits = Collections @@ -742,8 +740,6 @@ public class PackWriter implements AutoCloseable { * Must not be {@code null}. * @throws IOException * an I/O problem occured while reading objects. - * - * @since 4.5 */ public void preparePack(ProgressMonitor countingMonitor, @NonNull Set want, @@ -1089,8 +1085,6 @@ public class PackWriter implements AutoCloseable { /** * Release all resources used by this writer. - * - * @since 4.0 */ @Override public void close() { @@ -2258,8 +2252,6 @@ public class PackWriter implements AutoCloseable { * @return the count of objects that needed to be discovered through an * object walk because they were not found in bitmap indices. * Returns -1 if no bitmap indices were found. - * - * @since 4.0 */ public long getBitmapIndexMisses() { return statistics.getBitmapIndexMisses();