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
This commit is contained in:
parent
8bec98cec0
commit
061d24f6d5
|
@ -68,7 +68,6 @@ public static CLIText get() {
|
|||
* @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 static String formatLine(String line) {
|
|||
* @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);
|
||||
|
|
|
@ -46,8 +46,6 @@
|
|||
* 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 {
|
||||
|
||||
|
|
|
@ -44,8 +44,6 @@
|
|||
|
||||
/**
|
||||
* Generic string matcher
|
||||
*
|
||||
* @since 3.6
|
||||
*/
|
||||
public interface IMatcher {
|
||||
|
||||
|
|
|
@ -44,8 +44,6 @@
|
|||
|
||||
/**
|
||||
* Matcher for simple regex patterns starting with an asterisk, e.g. "*.tmp"
|
||||
*
|
||||
* @since 3.6
|
||||
*/
|
||||
public class LeadingAsteriskMatcher extends NameMatcher {
|
||||
|
||||
|
|
|
@ -47,8 +47,6 @@
|
|||
/**
|
||||
* 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 {
|
||||
|
||||
|
|
|
@ -59,8 +59,6 @@
|
|||
* 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 {
|
||||
|
||||
|
|
|
@ -58,8 +58,6 @@
|
|||
/**
|
||||
* 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 {
|
||||
|
||||
|
|
|
@ -44,8 +44,6 @@
|
|||
|
||||
/**
|
||||
* Matcher for simple patterns ending with an asterisk, e.g. "Makefile.*"
|
||||
*
|
||||
* @since 3.6
|
||||
*/
|
||||
public class TrailingAsteriskMatcher extends NameMatcher {
|
||||
|
||||
|
|
|
@ -53,8 +53,6 @@
|
|||
* glob wildcards to Java {@link Pattern}'s.
|
||||
* <p>
|
||||
* This class is immutable and thread safe.
|
||||
*
|
||||
* @since 3.6
|
||||
*/
|
||||
public class WildCardMatcher extends NameMatcher {
|
||||
|
||||
|
|
|
@ -47,8 +47,6 @@
|
|||
* matcher matches any path.
|
||||
* <p>
|
||||
* This class is immutable and thread safe.
|
||||
*
|
||||
* @since 3.6
|
||||
*/
|
||||
public final class WildMatcher extends AbstractMatcher {
|
||||
|
||||
|
|
|
@ -47,8 +47,6 @@
|
|||
|
||||
/**
|
||||
* Receives {@link BeforeDfsPackIndexLoadedEvent}s.
|
||||
*
|
||||
* @since 2.2
|
||||
*/
|
||||
public interface BeforeDfsPackIndexLoadedListener extends RepositoryListener {
|
||||
/**
|
||||
|
|
|
@ -122,7 +122,6 @@ public DfsBlockCacheConfig setBlockSize(final int newSize) {
|
|||
/**
|
||||
* @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 int getConcurrencyLevel() {
|
|||
* 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 DfsBlockCacheConfig setConcurrencyLevel(
|
|||
* @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 double getStreamRatio() {
|
|||
* @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));
|
||||
|
|
|
@ -187,7 +187,6 @@ public DfsPackDescription getPackDescription() {
|
|||
|
||||
/**
|
||||
* @return whether the pack index file is loaded and cached in memory.
|
||||
* @since 2.2
|
||||
*/
|
||||
public boolean isIndexLoaded() {
|
||||
DfsBlockCache.Ref<PackIndex> idxref = index;
|
||||
|
|
|
@ -109,7 +109,6 @@ public DfsReaderOptions setStreamFileThreshold(final int newLimit) {
|
|||
/**
|
||||
* @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 int getStreamPackBufferSize() {
|
|||
* 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);
|
||||
|
|
|
@ -63,7 +63,6 @@ public InMemoryRepository build() throws IOException {
|
|||
*
|
||||
* @param repoDesc
|
||||
* description of the repository.
|
||||
* @since 2.0
|
||||
*/
|
||||
public InMemoryRepository(DfsRepositoryDescription repoDesc) {
|
||||
this(new Builder().setRepositoryDescription(repoDesc));
|
||||
|
|
|
@ -1161,7 +1161,6 @@ public void setPackExpireAgeMillis(long packExpireAgeMillis) {
|
|||
* 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 void setPackExpire(Date packExpire) {
|
|||
*
|
||||
* @param auto
|
||||
* defines whether gc should do automatic housekeeping
|
||||
* @since 4.5
|
||||
*/
|
||||
public void setAuto(boolean auto) {
|
||||
this.automatic = auto;
|
||||
|
|
|
@ -150,7 +150,6 @@ public LockFile(final File f, final FS fs) {
|
|||
*
|
||||
* @param f
|
||||
* the file that will be locked.
|
||||
* @since 4.2
|
||||
*/
|
||||
public LockFile(final File f) {
|
||||
ref = f;
|
||||
|
|
|
@ -74,8 +74,6 @@
|
|||
|
||||
/**
|
||||
* Utility for writing reflog entries
|
||||
*
|
||||
* @since 2.0
|
||||
*/
|
||||
public class ReflogWriter {
|
||||
|
||||
|
|
|
@ -369,7 +369,6 @@ public PackWriter(final PackConfig config, final ObjectReader reader) {
|
|||
* 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 PackWriter setObjectCountCallback(ObjectCountCallback callback) {
|
|||
*
|
||||
* @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 void preparePack(ProgressMonitor countingMonitor,
|
|||
* 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 State getState() {
|
|||
|
||||
/**
|
||||
* Release all resources used by this writer.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
@Override
|
||||
public void close() {
|
||||
|
@ -2258,8 +2252,6 @@ public long getTotalObjects() {
|
|||
* @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();
|
||||
|
|
Loading…
Reference in New Issue