]> source.dussan.org Git - jgit.git/commitdiff
Remove @since tags from internal packages 62/89462/3
authorJonathan Nieder <jrn@google.com>
Tue, 24 Jan 2017 18:16:19 +0000 (10:16 -0800)
committerJonathan Nieder <jrn@google.com>
Tue, 24 Jan 2017 22:41:24 +0000 (14:41 -0800)
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

19 files changed:
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/AbstractMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/IMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/LeadingAsteriskMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/NameMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/PathMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/Strings.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/TrailingAsteriskMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildCardMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/ignore/internal/WildMatcher.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/BeforeDfsPackIndexLoadedListener.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsBlockCacheConfig.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsPackFile.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/DfsReaderOptions.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/dfs/InMemoryRepository.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/LockFile.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/ReflogWriter.java
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/pack/PackWriter.java

index 90c03e99b5289931e6b6d166473303263fa318e8..4842b98731caaf8b2c671e30200c30dcf117db58 100644 (file)
@@ -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);
index 4e90d8c3cb359304524c1d166eb8805fe76af074..64c2a74554bd3c7ead4df8884d7080b7199ea870 100644 (file)
@@ -46,8 +46,6 @@ package org.eclipse.jgit.ignore.internal;
  * Base class for default methods as {@link #toString()} and such.
  * <p>
  * This class is immutable and thread safe.
- *
- * @since 3.6
  */
 public abstract class AbstractMatcher implements IMatcher {
 
index 8bb4dfb564ba99ae52716cb574260cfc12e1a82c..4c13e2ff6a7f9ae89d89943626dc570fb3d3a035 100644 (file)
@@ -44,8 +44,6 @@ package org.eclipse.jgit.ignore.internal;
 
 /**
  * Generic string matcher
- *
- * @since 3.6
  */
 public interface IMatcher {
 
index 3d0ad09124d211ab64b3213d158431416e7a38b2..3ebc6afb2c4effc94041988e7a219f8b49fc596a 100644 (file)
@@ -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 {
 
index 8beae8379e5beab4f39694742981d5d75bca1607..888b989b62aea117b05d93116c6899c7954a3f21 100644 (file)
@@ -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 {
 
index c3f6694a7ae350140eb1feaaa1f145aa7c1de379..adf13292bfd80647621d9a72179016d51389572f 100644 (file)
@@ -59,8 +59,6 @@ import org.eclipse.jgit.ignore.internal.Strings.PatternState;
  * Matcher built by patterns consists of multiple path segments.
  * <p>
  * This class is immutable and thread safe.
- *
- * @since 3.6
  */
 public class PathMatcher extends AbstractMatcher {
 
index 70c51990301df071699087606106289a48779540..1c467fe71b3a97a57004dec54c8220456e89bf53 100644 (file)
@@ -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 {
 
index b927d27dbe0297546644db236f102c2e556e7776..c7064ac85120030341d80421b63b86c7aaefe31c 100644 (file)
@@ -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 {
 
index 8f9815283def081ff088323c3f85eabec3d40a1b..f64050f83c095491c75b4fbc7f4eabfac203fb02 100644 (file)
@@ -53,8 +53,6 @@ import org.eclipse.jgit.errors.InvalidPatternException;
  * glob wildcards to Java {@link Pattern}'s.
  * <p>
  * This class is immutable and thread safe.
- *
- * @since 3.6
  */
 public class WildCardMatcher extends NameMatcher {
 
index d578654375ceb59adcc7b4bbe60d18efe98400d2..2f24e02410cee7647ab1e12d1a80ba163eeb32e1 100644 (file)
@@ -47,8 +47,6 @@ package org.eclipse.jgit.ignore.internal;
  * matcher matches any path.
  * <p>
  * This class is immutable and thread safe.
- *
- * @since 3.6
  */
 public final class WildMatcher extends AbstractMatcher {
 
index 047c86f2894cc4289737a8e0d529330c39e70015..9f7f350833b4d60754b7fe952bb4b51fc3c9d5e3 100644 (file)
@@ -47,8 +47,6 @@ import org.eclipse.jgit.events.RepositoryListener;
 
 /**
  * Receives {@link BeforeDfsPackIndexLoadedEvent}s.
- *
- * @since 2.2
  */
 public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener {
        /**
index 089bfa471dd602e87517f9c9458dcefdfb4474b0..feadedbc88be9be36c147dac056cdbc0ac72a84f 100644 (file)
@@ -122,7 +122,6 @@ public class DfsBlockCacheConfig {
        /**
         * @return the estimated number of threads concurrently accessing the cache.
         *         <b>Default is 32.</b>
-        * @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. <b>Default
         *         is 0.30, or 30%</b>.
-        * @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));
index a3d79ecb63ce742578b6c49205a7d9d44d036c08..f15d427f8d80f7c7f96d9926188dcc4cff542903 100644 (file)
@@ -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<PackIndex> idxref = index;
index 84198077eb5c6791bbe056785dd0ea3533b9cc3c..d07c13d0b001971e546c7947d6f3d8bcfb594ed9 100644 (file)
@@ -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);
index fd213977a8b92db35f0bdb1076cf281d5344e70e..bdcf9f9a14c48b9fccc619d94291c9a8e01b1377 100644 (file)
@@ -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));
index 32ea382a25d4bb3b9d7e02ff8872c976d973c275..1caa35f13f0a0fd39ffe46a8473794f728c84141 100644 (file)
@@ -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;
index ce9677a62da09496512d60c56ccf4f02a35766fd..fcc8d7178cd879e27121f075200b0fe63b7f5f76 100644 (file)
@@ -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;
index fc802666bc37bf423a4a3bd8ffb6f48f862a50c7..24d2c790eee8cc1ab3f15655919bb8170b71fff5 100644 (file)
@@ -74,8 +74,6 @@ import org.eclipse.jgit.util.FileUtils;
 
 /**
  * Utility for writing reflog entries
- *
- * @since 2.0
  */
 public class ReflogWriter {
 
index a5764be4d76c40e07c4aafaef529661baa3dc9d0..ffab1a74659761fd7caabd03b8b405f1380bf6be 100644 (file)
@@ -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<ObjectId> 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<? extends ObjectId> 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();