diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java index 86b8d85ff..8658b0709 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyCommand.java @@ -68,6 +68,7 @@ import org.eclipse.jgit.util.IO; * * @see Git documentation about apply + * @since 2.0 */ public class ApplyCommand extends GitCommand { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java index 0c38f1b48..558ef0f8a 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ApplyResult.java @@ -48,6 +48,8 @@ import java.util.List; /** * Encapsulates the result of a {@link ApplyCommand} + * + * @since 2.0 */ public class ApplyResult { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java index e03805b72..e6d56c8e6 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CheckoutCommand.java @@ -253,6 +253,7 @@ public class CheckoutCommand extends GitCommand { * @param all * true to checkout all paths, false otherwise * @return {@code this} + * @since 2.0 */ public CheckoutCommand setAllPaths(boolean all) { checkoutAllPaths = all; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java index f52358633..8a86af876 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -576,6 +576,7 @@ public class Git { * Returns a command object used to create a stashed commit * * @return a {@link StashCreateCommand} + * @since 2.0 */ public StashCreateCommand stashCreate() { return new StashCreateCommand(repo); @@ -585,6 +586,7 @@ public class Git { * Returns a command object used to apply a stashed commit * * @return a {@link StashApplyCommand} + * @since 2.0 */ public StashApplyCommand stashApply() { return new StashApplyCommand(repo); @@ -594,6 +596,7 @@ public class Git { * Returns a command object used to drop a stashed commit * * @return a {@link StashDropCommand} + * @since 2.0 */ public StashDropCommand stashDrop() { return new StashDropCommand(repo); @@ -608,6 +611,7 @@ public class Git { * * @return a {@link ApplyCommand} used to collect all optional parameters * and to finally execute the {@code apply} command + * @since 2.0 */ public ApplyCommand apply() { return new ApplyCommand(repo); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java index 4739f1617..a09f8c28a 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/RebaseResult.java @@ -113,6 +113,8 @@ public class RebaseResult { /** * Continue with nothing left to commit (possibly want skip). + * + * @since 2.0 */ NOTHING_TO_COMMIT { @Override diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java index 104c22f2a..5ba61622e 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashCreateCommand.java @@ -85,6 +85,7 @@ import org.eclipse.jgit.treewalk.filter.SkipWorkTreeFilter; * * @see Git documentation about Stash + * @since 2.0 */ public class StashCreateCommand extends GitCommand { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java index 85bb987ff..e718417d1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashDropCommand.java @@ -69,6 +69,7 @@ import org.eclipse.jgit.util.FileUtils; * * @see Git documentation about Stash + * @since 2.0 */ public class StashDropCommand extends GitCommand { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java index 30d548cd6..c867b53e8 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/TagCommand.java @@ -105,6 +105,7 @@ public class TagCommand extends GitCommand { * exception can be retrieved by calling * {@link Exception#getCause()}. Expect only * {@code IOException's} to be wrapped. + * @since 2.0 */ public Ref call() throws JGitInternalException, ConcurrentRefUpdateException, InvalidTagNameException, NoHeadException { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java b/org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java index e7d0213b2..ceb4cb0c0 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/diff/DiffFormatter.java @@ -278,6 +278,7 @@ public class DiffFormatter { * Get the prefix applied in front of old file paths. * * @return the prefix + * @since 2.0 */ public String getOldPrefix() { return this.oldPrefix; @@ -298,8 +299,9 @@ public class DiffFormatter { /** * Get the prefix applied in front of new file paths. - * + * * @return the prefix + * @since 2.0 */ public String getNewPrefix() { return this.newPrefix; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java index 155519f28..698636c8c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/InvalidPathException.java @@ -49,6 +49,8 @@ import org.eclipse.jgit.internal.JGitText; /** * Thrown when JGit detects and refuses to use an invalid path + * + * @since 2.0 */ public class InvalidPathException extends IllegalArgumentException { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java index f363fc242..fb62acedf 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/dfs/InMemoryRepository.java @@ -34,7 +34,8 @@ public class InMemoryRepository extends DfsRepository { * Initialize a new in-memory repository. * * @param repoDesc - * description of the repository. + * description of the repository. + * @since 2.0 */ public InMemoryRepository(DfsRepositoryDescription repoDesc) { super(new DfsRepositoryBuilder() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java index 684e97d13..d7788cd8f 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/ReflogWriter.java @@ -73,6 +73,8 @@ 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/transport/AbstractAdvertiseRefsHook.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java index d17e074d6..a13a4ff93 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/AbstractAdvertiseRefsHook.java @@ -53,6 +53,8 @@ import org.eclipse.jgit.revwalk.RevWalk; /** * Implementation of {@link AdvertiseRefsHook} that advertises the same refs for * upload-pack and receive-pack. + * + * @since 2.0 */ public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook { public void advertiseRefs(UploadPack uploadPack) diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java index f61c18643..0f76f6752 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/AdvertiseRefsHook.java @@ -42,7 +42,11 @@ package org.eclipse.jgit.transport; -/** Hook to allow callers to take over advertising refs to the client. */ +/** + * Hook to allow callers to take over advertising refs to the client. + * + * @since 2.0 + */ public interface AdvertiseRefsHook { /** * A simple hook that advertises the default refs. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java index 347fd9330..582b75a25 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java @@ -120,34 +120,64 @@ public abstract class BasePackFetchConnection extends BasePackConnection */ protected static final int MIN_CLIENT_BUFFER = 2 * 32 * 46 + 8; - /** Include tags if we are also including the referenced objects. */ + /** + * Include tags if we are also including the referenced objects. + * @since 2.0 + */ public static final String OPTION_INCLUDE_TAG = "include-tag"; - /** Mutli-ACK support for improved negotiation. */ + /** + * Mutli-ACK support for improved negotiation. + * @since 2.0 + */ public static final String OPTION_MULTI_ACK = "multi_ack"; - /** Mutli-ACK detailed support for improved negotiation. */ + /** + * Mutli-ACK detailed support for improved negotiation. + * @since 2.0 + */ public static final String OPTION_MULTI_ACK_DETAILED = "multi_ack_detailed"; - /** The client supports packs with deltas but not their bases. */ + /** + * The client supports packs with deltas but not their bases. + * @since 2.0 + */ public static final String OPTION_THIN_PACK = "thin-pack"; - /** The client supports using the side-band for progress messages. */ + /** + * The client supports using the side-band for progress messages. + * @since 2.0 + */ public static final String OPTION_SIDE_BAND = "side-band"; - /** The client supports using the 64K side-band for progress messages. */ + /** + * The client supports using the 64K side-band for progress messages. + * @since 2.0 + */ public static final String OPTION_SIDE_BAND_64K = "side-band-64k"; - /** The client supports packs with OFS deltas. */ + /** + * The client supports packs with OFS deltas. + * @since 2.0 + */ public static final String OPTION_OFS_DELTA = "ofs-delta"; - /** The client supports shallow fetches. */ + /** + * The client supports shallow fetches. + * @since 2.0 + */ public static final String OPTION_SHALLOW = "shallow"; - /** The client does not want progress messages and will ignore them. */ + /** + * The client does not want progress messages and will ignore them. + * @since 2.0 + */ public static final String OPTION_NO_PROGRESS = "no-progress"; - /** The client supports receiving a pack before it has sent "done". */ + /** + * The client supports receiving a pack before it has sent "done". + * @since 2.0 + */ public static final String OPTION_NO_DONE = "no-done"; static enum MultiAck { @@ -695,6 +725,8 @@ public abstract class BasePackFetchConnection extends BasePackConnection * Notification event delivered just before the pack is received from the * network. This event can be used by RPC such as {@link TransportHttp} to * disable its request magic and ensure the pack stream is read correctly. + * + * @since 2.0 */ protected void onReceivePack() { // By default do nothing for TCP based protocols. diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java index 8bf030bb8..119b26616 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackPushConnection.java @@ -83,16 +83,28 @@ import org.eclipse.jgit.transport.RemoteRefUpdate.Status; */ public abstract class BasePackPushConnection extends BasePackConnection implements PushConnection { - /** The client expects a status report after the server processes the pack. */ + /** + * The client expects a status report after the server processes the pack. + * @since 2.0 + */ public static final String CAPABILITY_REPORT_STATUS = "report-status"; - /** The server supports deleting refs. */ + /** + * The server supports deleting refs. + * @since 2.0 + */ public static final String CAPABILITY_DELETE_REFS = "delete-refs"; - /** The server supports packs with OFS deltas. */ + /** + * The server supports packs with OFS deltas. + * @since 2.0 + */ public static final String CAPABILITY_OFS_DELTA = "ofs-delta"; - /** The client supports using the 64K side-band for progress messages. */ + /** + * The client supports using the 64K side-band for progress messages. + * @since 2.0 + */ public static final String CAPABILITY_SIDE_BAND_64K = "side-band-64k"; private final boolean thinPack; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java index 0a0de5b61..44cf82916 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceiveCommand.java @@ -129,8 +129,9 @@ public class ReceiveCommand { * commands to filter. * @param want * desired status to filter by. - * @return a copy of the command list containing only those commands with the - * desired status. + * @return a copy of the command list containing only those commands with + * the desired status. + * @since 2.0 */ public static List filter(List commands, final Result want) { @@ -195,6 +196,7 @@ public class ReceiveCommand { * name of the ref being affected. * @param type * type of the command. + * @since 2.0 */ public ReceiveCommand(final ObjectId oldId, final ObjectId newId, final String name, final Type type) { @@ -269,6 +271,7 @@ public class ReceiveCommand { * * @param rp * receive-pack session. + * @since 2.0 */ public void execute(final ReceivePack rp) { try { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java index 4de6fa30e..8b45174c0 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RequestNotYetReadException.java @@ -43,7 +43,11 @@ package org.eclipse.jgit.transport; -/** Indicates that a client request has not yet been read from the wire. */ +/** + * Indicates that a client request has not yet been read from the wire. + * + * @since 2.0 + */ public class RequestNotYetReadException extends IllegalStateException { private static final long serialVersionUID = 1L; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java index bf85068f2..86f644682 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ServiceMayNotContinueException.java @@ -45,7 +45,11 @@ package org.eclipse.jgit.transport; import java.io.IOException; -/** Indicates a transport service may not continue execution. */ +/** + * Indicates a transport service may not continue execution. + * + * @since 2.0 + */ public class ServiceMayNotContinueException extends IOException { private static final long serialVersionUID = 1L; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java index 8fe78b680..770fcbed8 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandOutputStream.java @@ -54,6 +54,8 @@ import org.eclipse.jgit.internal.JGitText; *

* This stream is buffered at packet sizes, so the caller doesn't need to wrap * it in yet another buffered stream. + * + * @since 2.0 */ public class SideBandOutputStream extends OutputStream { /** Channel used for pack data. */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java index ca5fec2a9..752f20bf3 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java @@ -651,6 +651,7 @@ public abstract class AbstractTreeIterator { * JGit internal API for use by {@link DirCacheCheckout} * * @return start of name component part within {@link #getEntryPathBuffer()} + * @since 2.0 */ public int getNameOffset() { return pathOffset; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java index 604363847..11215c8c1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/FileUtils.java @@ -79,6 +79,7 @@ public class FileUtils { /** * Option not to throw exceptions when a deletion finally doesn't succeed. + * @since 2.0 */ public static final int IGNORE_ERRORS = 8; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java index 910d98201..4abe4a875 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/IO.java @@ -339,6 +339,7 @@ public class IO { * @param s * the string to read * @return the string divided into lines + * @since 2.0 */ public static List readLines(final String s) { List l = new ArrayList(); diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java index f423f98e2..efb9abd87 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/StringUtils.java @@ -132,6 +132,7 @@ public final class StringUtils { * second string to compare. * @return negative, zero or positive if a sorts before, is equal to, or * sorts after b. + * @since 2.0 */ public static int compareIgnoreCase(String a, String b) { for (int i = 0; i < a.length() && i < b.length(); i++) { @@ -154,6 +155,7 @@ public final class StringUtils { * second string to compare. * @return negative, zero or positive if a sorts before, is equal to, or * sorts after b. + * @since 2.0 */ public static int compareWithCase(String a, String b) { for (int i = 0; i < a.length() && i < b.length(); i++) { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java index 954c64676..592183658 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/io/EolCanonicalizingInputStream.java @@ -72,11 +72,12 @@ public class EolCanonicalizingInputStream extends InputStream { /** * Creates a new InputStream, wrapping the specified stream - * + * * @param in * raw input stream * @param detectBinary * whether binaries should be detected + * @since 2.0 */ public EolCanonicalizingInputStream(InputStream in, boolean detectBinary) { this.in = in;