Browse Source

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
stable-4.7
Jonathan Nieder 8 years ago
parent
commit
061d24f6d5
  1. 2
      org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java
  2. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java
  3. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java
  4. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java
  5. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java
  6. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java
  7. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java
  8. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java
  9. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java
  10. 2
      org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java
  11. 2
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java
  12. 4
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java
  13. 1
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java
  14. 2
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java
  15. 1
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java
  16. 2
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
  17. 1
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java
  18. 2
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java
  19. 8
      org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java

2
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java

@ -68,7 +68,6 @@ public class CLIText extends TranslationBundle {
* @param line * @param line
* the line to format * the line to format
* @return the formatted line * @return the formatted line
* @since 2.2
*/ */
public static String formatLine(String line) { public static String formatLine(String line) {
return MessageFormat.format(get().lineFormat, line); return MessageFormat.format(get().lineFormat, line);
@ -81,7 +80,6 @@ public class CLIText extends TranslationBundle {
* @param message * @param message
* the message to format * the message to format
* @return the formatted line * @return the formatted line
* @since 4.2
*/ */
public static String fatalError(String message) { public static String fatalError(String message) {
return MessageFormat.format(get().fatalError, message); return MessageFormat.format(get().fatalError, message);

2
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. * Base class for default methods as {@link #toString()} and such.
* <p> * <p>
* This class is immutable and thread safe. * This class is immutable and thread safe.
*
* @since 3.6
*/ */
public abstract class AbstractMatcher implements IMatcher { public abstract class AbstractMatcher implements IMatcher {

2
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java

@ -44,8 +44,6 @@ package org.eclipse.jgit.ignore.internal;
/** /**
* Generic string matcher * Generic string matcher
*
* @since 3.6
*/ */
public interface IMatcher { public interface IMatcher {

2
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" * Matcher for simple regex patterns starting with an asterisk, e.g. "*.tmp"
*
* @since 3.6
*/ */
public class LeadingAsteriskMatcher extends NameMatcher { public class LeadingAsteriskMatcher extends NameMatcher {

2
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 * Matcher built from patterns for file names (single path segments). This class
* is immutable and thread safe. * is immutable and thread safe.
*
* @since 3.6
*/ */
public class NameMatcher extends AbstractMatcher { public class NameMatcher extends AbstractMatcher {

2
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. * Matcher built by patterns consists of multiple path segments.
* <p> * <p>
* This class is immutable and thread safe. * This class is immutable and thread safe.
*
* @since 3.6
*/ */
public class PathMatcher extends AbstractMatcher { public class PathMatcher extends AbstractMatcher {

2
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 * Various {@link String} related utility methods, written mostly to avoid
* generation of new String objects (e.g. via splitting Strings etc). * generation of new String objects (e.g. via splitting Strings etc).
*
* @since 3.6
*/ */
public class Strings { public class Strings {

2
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.*" * Matcher for simple patterns ending with an asterisk, e.g. "Makefile.*"
*
* @since 3.6
*/ */
public class TrailingAsteriskMatcher extends NameMatcher { public class TrailingAsteriskMatcher extends NameMatcher {

2
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. * glob wildcards to Java {@link Pattern}'s.
* <p> * <p>
* This class is immutable and thread safe. * This class is immutable and thread safe.
*
* @since 3.6
*/ */
public class WildCardMatcher extends NameMatcher { public class WildCardMatcher extends NameMatcher {

2
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. * matcher matches any path.
* <p> * <p>
* This class is immutable and thread safe. * This class is immutable and thread safe.
*
* @since 3.6
*/ */
public final class WildMatcher extends AbstractMatcher { public final class WildMatcher extends AbstractMatcher {

2
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. * Receives {@link BeforeDfsPackIndexLoadedEvent}s.
*
* @since 2.2
*/ */
public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener { public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener {
/** /**

4
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. * @return the estimated number of threads concurrently accessing the cache.
* <b>Default is 32.</b> * <b>Default is 32.</b>
* @since 4.6
*/ */
public int getConcurrencyLevel() { public int getConcurrencyLevel() {
return concurrencyLevel; return concurrencyLevel;
@ -133,7 +132,6 @@ public class DfsBlockCacheConfig {
* the estimated number of threads concurrently accessing the * the estimated number of threads concurrently accessing the
* cache. * cache.
* @return {@code this} * @return {@code this}
* @since 4.6
*/ */
public DfsBlockCacheConfig setConcurrencyLevel( public DfsBlockCacheConfig setConcurrencyLevel(
final int newConcurrencyLevel) { final int newConcurrencyLevel) {
@ -145,7 +143,6 @@ public class DfsBlockCacheConfig {
* @return highest percentage of {@link #getBlockLimit()} a single pack can * @return highest percentage of {@link #getBlockLimit()} a single pack can
* occupy while being copied by the pack reuse strategy. <b>Default * occupy while being copied by the pack reuse strategy. <b>Default
* is 0.30, or 30%</b>. * is 0.30, or 30%</b>.
* @since 4.0
*/ */
public double getStreamRatio() { public double getStreamRatio() {
return streamRatio; return streamRatio;
@ -155,7 +152,6 @@ public class DfsBlockCacheConfig {
* @param ratio * @param ratio
* percentage of cache to occupy with a copied pack. * percentage of cache to occupy with a copied pack.
* @return {@code this} * @return {@code this}
* @since 4.0
*/ */
public DfsBlockCacheConfig setStreamRatio(double ratio) { public DfsBlockCacheConfig setStreamRatio(double ratio) {
streamRatio = Math.max(0, Math.min(ratio, 1.0)); streamRatio = Math.max(0, Math.min(ratio, 1.0));

1
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. * @return whether the pack index file is loaded and cached in memory.
* @since 2.2
*/ */
public boolean isIndexLoaded() { public boolean isIndexLoaded() {
DfsBlockCache.Ref<PackIndex> idxref = index; DfsBlockCache.Ref<PackIndex> idxref = index;

2
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 * @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. * during copying. If 0 the block size of the pack is used.
* @since 4.0
*/ */
public int getStreamPackBufferSize() { public int getStreamPackBufferSize() {
return streamPackBufferSize; return streamPackBufferSize;
@ -120,7 +119,6 @@ public class DfsReaderOptions {
* new buffer size in bytes for buffers used when streaming pack * new buffer size in bytes for buffers used when streaming pack
* files during copying. * files during copying.
* @return {@code this} * @return {@code this}
* @since 4.0
*/ */
public DfsReaderOptions setStreamPackBufferSize(int bufsz) { public DfsReaderOptions setStreamPackBufferSize(int bufsz) {
streamPackBufferSize = Math.max(0, bufsz); streamPackBufferSize = Math.max(0, bufsz);

1
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java

@ -63,7 +63,6 @@ public class InMemoryRepository extends DfsRepository {
* *
* @param repoDesc * @param repoDesc
* description of the repository. * description of the repository.
* @since 2.0
*/ */
public InMemoryRepository(DfsRepositoryDescription repoDesc) { public InMemoryRepository(DfsRepositoryDescription repoDesc) {
this(new Builder().setRepositoryDescription(repoDesc)); this(new Builder().setRepositoryDescription(repoDesc));

2
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 * influence how packs are written and to implement something similar to
* "git gc --aggressive" * "git gc --aggressive"
* *
* @since 3.6
* @param pconfig * @param pconfig
* the {@link PackConfig} used when writing packs * the {@link PackConfig} used when writing packs
*/ */
@ -1234,7 +1233,6 @@ public class GC {
* *
* @param auto * @param auto
* defines whether gc should do automatic housekeeping * defines whether gc should do automatic housekeeping
* @since 4.5
*/ */
public void setAuto(boolean auto) { public void setAuto(boolean auto) {
this.automatic = auto; this.automatic = auto;

1
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java

@ -150,7 +150,6 @@ public class LockFile {
* *
* @param f * @param f
* the file that will be locked. * the file that will be locked.
* @since 4.2
*/ */
public LockFile(final File f) { public LockFile(final File f) {
ref = f; ref = f;

2
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 * Utility for writing reflog entries
*
* @since 2.0
*/ */
public class ReflogWriter { public class ReflogWriter {

8
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 * the callback to set
* *
* @return this object for chaining. * @return this object for chaining.
* @since 4.1
*/ */
public PackWriter setObjectCountCallback(ObjectCountCallback callback) { public PackWriter setObjectCountCallback(ObjectCountCallback callback) {
this.callback = callback; this.callback = callback;
@ -381,7 +380,6 @@ public class PackWriter implements AutoCloseable {
* *
* @param clientShallowCommits * @param clientShallowCommits
* the shallow commits in the client * the shallow commits in the client
* @since 4.1
*/ */
public void setClientShallowCommits(Set<ObjectId> clientShallowCommits) { public void setClientShallowCommits(Set<ObjectId> clientShallowCommits) {
stats.clientShallowCommits = Collections stats.clientShallowCommits = Collections
@ -742,8 +740,6 @@ public class PackWriter implements AutoCloseable {
* Must not be {@code null}. * Must not be {@code null}.
* @throws IOException * @throws IOException
* an I/O problem occured while reading objects. * an I/O problem occured while reading objects.
*
* @since 4.5
*/ */
public void preparePack(ProgressMonitor countingMonitor, public void preparePack(ProgressMonitor countingMonitor,
@NonNull Set<? extends ObjectId> want, @NonNull Set<? extends ObjectId> want,
@ -1089,8 +1085,6 @@ public class PackWriter implements AutoCloseable {
/** /**
* Release all resources used by this writer. * Release all resources used by this writer.
*
* @since 4.0
*/ */
@Override @Override
public void close() { public void close() {
@ -2258,8 +2252,6 @@ public class PackWriter implements AutoCloseable {
* @return the count of objects that needed to be discovered through an * @return the count of objects that needed to be discovered through an
* object walk because they were not found in bitmap indices. * object walk because they were not found in bitmap indices.
* Returns -1 if no bitmap indices were found. * Returns -1 if no bitmap indices were found.
*
* @since 4.0
*/ */
public long getBitmapIndexMisses() { public long getBitmapIndexMisses() {
return statistics.getBitmapIndexMisses(); return statistics.getBitmapIndexMisses();

Loading…
Cancel
Save