Add missing @since tags
Change-Id: I6b20d78e6bd1f245fdca331554c106f8bae44b9c Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
parent
48f30b8614
commit
dd6f41e401
|
@ -1269,7 +1269,9 @@ public static String shortenRefName(String refName) {
|
|||
* @param refName
|
||||
* @return a {@link ReflogReader} for the supplied refname, or null if the
|
||||
* named ref does not exist.
|
||||
* @throws IOException the ref could not be accessed.
|
||||
* @throws IOException
|
||||
* the ref could not be accessed.
|
||||
* @since 3.0
|
||||
*/
|
||||
public abstract ReflogReader getReflogReader(String refName)
|
||||
throws IOException;
|
||||
|
|
|
@ -76,6 +76,7 @@ public abstract class MergeStrategy {
|
|||
/**
|
||||
* Recursive strategy to merge paths. It tries to merge also contents.
|
||||
* Multiple merge bases are supported
|
||||
* @since 3.0
|
||||
*/
|
||||
public static final ThreeWayMergeStrategy RECURSIVE = new StrategyRecursive();
|
||||
|
||||
|
|
|
@ -197,6 +197,7 @@ public boolean merge(final AnyObjectId... tips) throws IOException {
|
|||
* one of the input objects is not a commit.
|
||||
* @throws IOException
|
||||
* objects are missing or multiple merge bases were found.
|
||||
* @since 3.0
|
||||
*/
|
||||
protected AbstractTreeIterator mergeBase(RevCommit a, RevCommit b)
|
||||
throws IOException {
|
||||
|
@ -241,6 +242,7 @@ public RevCommit getBaseCommit(final int aIdx, final int bIdx)
|
|||
* one of the input objects is not a commit.
|
||||
* @throws IOException
|
||||
* objects are missing or multiple merge bases were found.
|
||||
* @since 3.0
|
||||
*/
|
||||
protected RevCommit getBaseCommit(RevCommit a, RevCommit b)
|
||||
throws IncorrectObjectTypeException, IOException {
|
||||
|
|
|
@ -82,9 +82,8 @@
|
|||
* - uses "Lists" instead of Arrays for chained types
|
||||
*
|
||||
* - recursively merges the merge bases together to compute a usable base
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
|
||||
public class RecursiveMerger extends ResolveMerger {
|
||||
static Logger log = Logger.getLogger(RecursiveMerger.class.toString());
|
||||
|
||||
|
|
|
@ -109,6 +109,8 @@ public enum MergeFailureReason {
|
|||
|
||||
/**
|
||||
* string versions of a list of commit SHA1s
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
protected String commitNames[];
|
||||
|
||||
|
@ -126,6 +128,8 @@ public enum MergeFailureReason {
|
|||
|
||||
/**
|
||||
* merge result as tree
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
protected ObjectId resultTree;
|
||||
|
||||
|
@ -149,6 +153,7 @@ public enum MergeFailureReason {
|
|||
* created as temporary files and a new empty, in-memory dircache will be
|
||||
* used instead the repo's one. Often used for bare repos where the repo
|
||||
* doesn't even have a workingtree and dircache.
|
||||
* @since 3.0
|
||||
*/
|
||||
protected boolean inCore;
|
||||
|
||||
|
@ -157,22 +162,26 @@ public enum MergeFailureReason {
|
|||
* repository and should handle locking and unlocking of the dircache. If
|
||||
* this merger should work in-core or if an explicit dircache was specified
|
||||
* during construction then this field is set to false.
|
||||
* @since 3.0
|
||||
*/
|
||||
protected boolean implicitDirCache;
|
||||
|
||||
/**
|
||||
* Directory cache
|
||||
* @since 3.0
|
||||
*/
|
||||
protected DirCache dircache;
|
||||
|
||||
/**
|
||||
* The iterator to access the working tree. If set to <code>null</code> this
|
||||
* merger will not touch the working tree.
|
||||
* @since 3.0
|
||||
*/
|
||||
protected WorkingTreeIterator workingTreeIterator;
|
||||
|
||||
/**
|
||||
* our merge algorithm
|
||||
* @since 3.0
|
||||
*/
|
||||
protected MergeAlgorithm mergeAlgorithm;
|
||||
|
||||
|
@ -893,6 +902,7 @@ public void setWorkingTreeIterator(WorkingTreeIterator workingTreeIterator) {
|
|||
* @param mergeTree
|
||||
* @return whether the trees merged cleanly
|
||||
* @throws IOException
|
||||
* @since 3.0
|
||||
*/
|
||||
protected boolean mergeTrees(AbstractTreeIterator baseTree,
|
||||
RevTree headTree, RevTree mergeTree) throws IOException {
|
||||
|
|
|
@ -104,6 +104,7 @@ public Repository build() throws IOException {
|
|||
* @throws IOException
|
||||
* the repository could not be accessed to configure the rest of
|
||||
* the builder's parameters.
|
||||
* @since 3.0
|
||||
*/
|
||||
public static Repository create(File gitDir) throws IOException {
|
||||
return new FileRepositoryBuilder().setGitDir(gitDir).readEnvironment()
|
||||
|
|
|
@ -428,6 +428,7 @@ public List<PackedObjectInfo> getSortedObjectList(
|
|||
* {@link #setLockMessage(String)}.
|
||||
* @throws IOException
|
||||
* the stream is malformed, or contains corrupt objects.
|
||||
* @since 3.0
|
||||
*/
|
||||
public final PackLock parse(ProgressMonitor progress) throws IOException {
|
||||
return parse(progress, progress);
|
||||
|
@ -446,6 +447,7 @@ public final PackLock parse(ProgressMonitor progress) throws IOException {
|
|||
* {@link #setLockMessage(String)}.
|
||||
* @throws IOException
|
||||
* the stream is malformed, or contains corrupt objects.
|
||||
* @since 3.0
|
||||
*/
|
||||
public PackLock parse(ProgressMonitor receiving, ProgressMonitor resolving)
|
||||
throws IOException {
|
||||
|
|
|
@ -537,6 +537,7 @@ public void upload(final InputStream input, final OutputStream output,
|
|||
* @return statistics about pack output, if a pack was sent. Null if no pack
|
||||
* was sent, such as during the negotation phase of a smart HTTP
|
||||
* connection, or if the client was already up-to-date.
|
||||
* @since 3.0
|
||||
*/
|
||||
public PackWriter.Statistics getPackStatistics() {
|
||||
return statistics;
|
||||
|
|
|
@ -78,6 +78,9 @@ else if (i == 1)
|
|||
return new UploadPackLoggerChain(newLoggers, i);
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0
|
||||
*/
|
||||
public void onPackStatistics(PackWriter.Statistics stats) {
|
||||
for (int i = 0; i < count; i++)
|
||||
loggers[i].onPackStatistics(stats);
|
||||
|
|
|
@ -85,7 +85,7 @@ public AutoCRLF getAutoCRLF() {
|
|||
|
||||
/**
|
||||
* @return how stat data is compared
|
||||
* @since 2.3
|
||||
* @since 3.0
|
||||
*/
|
||||
public CheckStat getCheckStat() {
|
||||
return checkStat;
|
||||
|
|
Loading…
Reference in New Issue