For now ignore doclint "missing" warnings. Change-Id: I0e5af7a757f4d92ffeeb113f30576a35414d6781 Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>tags/v4.10.0.201712302008-r
@@ -92,7 +92,7 @@ public abstract class HttpTestCase extends LocalDiskRepositoryTestCase { | |||
} | |||
/** | |||
* Create the {@linkAppServer}.This default implementation creates a server | |||
* Create the {@link AppServer}.This default implementation creates a server | |||
* without SSLsupport listening for HTTP connections on a dynamically chosen | |||
* port, which can be gotten once the server has been started via its | |||
* {@link org.eclipse.jgit.junit.http.AppServer#getPort()} method. |
@@ -46,11 +46,10 @@ import java.util.List; | |||
import java.util.Map; | |||
/** | |||
* POJOs for Gson serialization/deserialization | |||
* POJOs for Gson serialization/de-serialization. | |||
* | |||
* See | |||
* {@link <a href="https://github.com/github/git-lfs/tree/master/docs/api">LFS | |||
* API specification</a>} | |||
* See the <a href="https://github.com/github/git-lfs/tree/master/docs/api">LFS | |||
* API specification</a> | |||
* | |||
* @since 4.3 | |||
*/ |
@@ -66,7 +66,7 @@ import org.eclipse.jgit.util.FileUtils; | |||
* content with content of a so-called LFS pointer file. The pointer file | |||
* content will then be added to the git repository. Additionally this filter | |||
* writes the original content in a so-called 'media file' to '.git/lfs/objects/ | |||
* <first-two-characters-of-contentid>/<rest-of-contentid>' | |||
* <first-two-characters-of-contentid>/<rest-of-contentid>' | |||
* | |||
* @see <a href="https://github.com/github/git-lfs/blob/master/docs/spec.md">Git | |||
* LFS Specification</a> |
@@ -49,7 +49,7 @@ import java.nio.file.Path; | |||
import org.eclipse.jgit.lfs.lib.AnyLongObjectId; | |||
/** | |||
* Class which represents the lfs folder hierarchy inside a .git folder | |||
* Class which represents the lfs folder hierarchy inside a {@code .git} folder | |||
* | |||
* @since 4.6 | |||
*/ | |||
@@ -64,7 +64,8 @@ public class Lfs { | |||
* Constructor for Lfs. | |||
* | |||
* @param root | |||
* the path to the LFS media directory. Will be "<repo>/.git/lfs" | |||
* the path to the LFS media directory. Will be | |||
* {@code "<repo>/.git/lfs"} | |||
*/ | |||
public Lfs(Path root) { | |||
this.root = root; | |||
@@ -110,9 +111,9 @@ public class Lfs { | |||
* | |||
* @param id | |||
* the id of the mediafile | |||
* @return the file which stores the original content. This will be files | |||
* underneath | |||
* "<repo>/.git/lfs/objects/<firstTwoLettersOfID>/<remainingLettersOfID>" | |||
* @return the file which stores the original content. Its path will look | |||
* like | |||
* {@code "<repo>/.git/lfs/objects/<firstTwoLettersOfID>/<remainingLettersOfID>"} | |||
*/ | |||
public Path getMediaFile(AnyLongObjectId id) { | |||
String idStr = id.name(); |
@@ -133,14 +133,15 @@ public final class Constants { | |||
} | |||
/** | |||
* Content type used by LFS REST API as defined in | |||
* {@link "https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md"} | |||
* Content type used by LFS REST API as defined in <a href= | |||
* "https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md"> | |||
* https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md</a> | |||
*/ | |||
public static final String CONTENT_TYPE_GIT_LFS_JSON = "application/vnd.git-lfs+json"; | |||
/** | |||
* "arbitrary binary data" as defined in RFC 2046 | |||
* {@link "https://www.ietf.org/rfc/rfc2046.txt"} | |||
* "Arbitrary binary data" as defined in | |||
* <a href="https://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a> | |||
*/ | |||
public static final String HDR_APPLICATION_OCTET_STREAM = "application/octet-stream"; | |||
} |
@@ -502,7 +502,8 @@ public class CheckoutTest extends CLIRepositoryTestCase { | |||
* <li>Create branch '1' | |||
* <li>Modify file 'a' | |||
* <li>Commit | |||
* <li>Delete file 'a' & replace by folder 'a' in the working tree & index | |||
* <li>Delete file 'a' and replace by folder 'a' in the working tree and | |||
* index | |||
* <li>Checkout branch '1' | |||
* </ol> | |||
* <p> | |||
@@ -555,7 +556,8 @@ public class CheckoutTest extends CLIRepositoryTestCase { | |||
* <li>Create branch '1' | |||
* <li>Modify file 'a' | |||
* <li>Commit | |||
* <li>Delete file 'a' & replace by folder 'a' in the working tree & index | |||
* <li>Delete file 'a' and replace by folder 'a' in the working tree and | |||
* index | |||
* <li>Checkout branch '1' | |||
* </ol> | |||
* <p> |
@@ -70,19 +70,19 @@ import org.junit.Test; | |||
* --------------------------------------------------------------------- | |||
* | HEAD DirCache Worktree | HEAD DirCache | |||
* --------------------------------------------------------------------- | |||
* f1_1 | - - c | => e: path unknown | |||
* f1_2 | - c - | => no changes | |||
* f1_1 | - - c | => e: path unknown | |||
* f1_2 | - c - | => no changes | |||
* f1_3 | c - - | - - | |||
* f1_4 | - c c | c c | |||
* f1_5 | c c - | - - | |||
* f1_6 | c - c | => no changes | |||
* f1_7 | c c c | => no changes | |||
* f1_6 | c - c | => no changes | |||
* f1_7 | c c c | => no changes | |||
* --------------------------------------------------------------------- | |||
* f1_8 | - c c' | c' c' | |||
* f1_9 | c - c' | c' c' | |||
* f1_10 | c c' - | - - | |||
* f1_11 | c c c' | c' c' | |||
* f1_12 | c c' c | => no changes | |||
* f1_12 | c c' c | => no changes | |||
* f1_13 | c c' c' | c' c' | |||
* --------------------------------------------------------------------- | |||
* f1_14 | c c' c'' | c'' c'' | |||
@@ -97,7 +97,7 @@ import org.junit.Test; | |||
* --------------------------------------------------------------------------- | |||
* | HEAD DirCache Worktree | HEAD DirCache | |||
* --------------------------------------------------------------------------- | |||
* f1_1_f2_14 | - - c | => e: path unknown | |||
* f1_1_f2_14 | - - c | => e: path unknown | |||
* f1_2_f2_14 | - c - | - - | |||
* f1_6_f2_14 | c - c | c c | |||
* f1_7_f2_14 | c c c | c c |
@@ -158,9 +158,9 @@ public class DescribeCommandTest extends RepositoryTestCase { | |||
* Make sure it finds a tag when not all ancestries include a tag. | |||
* | |||
* <pre> | |||
* c1 -+-> T - | |||
* c1 -+-> T - | |||
* | | | |||
* +-> c3 -+-> c4 | |||
* +-> c3 -+-> c4 | |||
* </pre> | |||
* | |||
* @throws Exception | |||
@@ -193,9 +193,9 @@ public class DescribeCommandTest extends RepositoryTestCase { | |||
* When t2 dominates t1, it's clearly preferable to describe by using t2. | |||
* | |||
* <pre> | |||
* t1 -+-> t2 - | |||
* t1 -+-> t2 - | |||
* | | | |||
* +-> c3 -+-> c4 | |||
* +-> c3 -+-> c4 | |||
* </pre> | |||
* | |||
* @throws Exception | |||
@@ -225,9 +225,9 @@ public class DescribeCommandTest extends RepositoryTestCase { | |||
* When t1 is nearer than t2, t2 should be found | |||
* | |||
* <pre> | |||
* c1 -+-> c2 -> t1 -+ | |||
* c1 -+-> c2 -> t1 -+ | |||
* | | | |||
* +-> t2 -> c3 -+-> c4 | |||
* +-> t2 -> c3 -+-> c4 | |||
* </pre> | |||
* | |||
* @throws Exception | |||
@@ -254,9 +254,9 @@ public class DescribeCommandTest extends RepositoryTestCase { | |||
* paths | |||
* | |||
* <pre> | |||
* c1 -+-> t1 -> c2 -+ | |||
* c1 -+-> t1 -> c2 -+ | |||
* | | | |||
* +-> t2 -> c3 -+-> c4 | |||
* +-> t2 -> c3 -+-> c4 | |||
* </pre> | |||
* | |||
* @throws Exception |
@@ -218,8 +218,8 @@ public class DirCacheCheckoutTest extends RepositoryTestCase { | |||
/** | |||
* Reset hard from unclean condition. | |||
* <p> | |||
* WorkDir: Empty <br/> | |||
* Index: f/g <br/> | |||
* WorkDir: Empty <br> | |||
* Index: f/g <br> | |||
* Merge: x | |||
* | |||
* @throws Exception |
@@ -145,8 +145,9 @@ public class RevWalkFollowFilterTest extends RevWalkTestCase { | |||
/** | |||
* Assert which renames should have happened, in traversal order. | |||
* | |||
* @param expectedRenames | |||
* the rename specs, each one in the form "srcPath->destPath" | |||
* the rename specs, each one in the form "srcPath->destPath" | |||
*/ | |||
protected void assertRenames(String... expectedRenames) { | |||
Assert.assertEquals("Unexpected number of renames. Expected: " + |
@@ -206,7 +206,7 @@ public class SymlinksTest extends RepositoryTestCase { | |||
* Steps: 1.Add file 'b' 2.Commit 3.Create branch '1' 4.Add symlink 'a' | |||
* 5.Commit 6.Checkout branch '1' | |||
* | |||
* The working tree should not contain 'a' -> FileMode.MISSING after the | |||
* The working tree should not contain 'a' -> FileMode.MISSING after the | |||
* checkout. | |||
* | |||
* @throws Exception |
@@ -58,10 +58,10 @@ import org.eclipse.jgit.util.FS; | |||
* <p> | |||
* This iterator is configured by a list of strictly increasing long values | |||
* t(0), t(1), ..., t(n). For each file with a modification between t(x) and | |||
* t(x+1) [ t(x) <= time < t(x+1) ] this iterator will report t(x). For files | |||
* with a modification time smaller t(0) a modification time of 0 is returned. | |||
* For files with a modification time greater or equal t(n) t(n) will be | |||
* returned. | |||
* t(x+1) [ t(x) <= time < t(x+1) ] this iterator will report t(x). For | |||
* files with a modification time smaller t(0) a modification time of 0 is | |||
* returned. For files with a modification time greater or equal t(n) t(n) will | |||
* be returned. | |||
* <p> | |||
* This class was written especially to test racy-git problems | |||
*/ |
@@ -331,8 +331,7 @@ public class PushCommand extends | |||
} | |||
/** | |||
* Get <code>RefSpec</code>s. | |||
* </p> | |||
* Get {@code RefSpec}s. | |||
* | |||
* @return the ref specs | |||
*/ |
@@ -58,7 +58,6 @@ package org.eclipse.jgit.attributes; | |||
* following (with lower priority) nodes from setting the attribute to a value | |||
* at all</li> | |||
* </ul> | |||
* </p> | |||
* | |||
* @since 3.7 | |||
*/ |
@@ -53,7 +53,6 @@ import org.eclipse.jgit.lib.Constants; | |||
/** | |||
* Represents a set of attributes for a path | |||
* <p> | |||
* | |||
* @since 4.2 | |||
*/ |
@@ -55,7 +55,7 @@ import org.slf4j.LoggerFactory; | |||
/** | |||
* "Fast" (compared with IgnoreRule) git ignore rule implementation supporting | |||
* also double star <code>**<code> pattern. | |||
* also double star {@code **} pattern. | |||
* <p> | |||
* This class is immutable and thread safe. | |||
* |
@@ -289,7 +289,7 @@ public class DfsGarbageCollector { | |||
* | |||
* @return garbage packs older than this limit (in milliseconds) will be | |||
* pruned as part of the garbage collection process if the value is | |||
* > 0, otherwise garbage packs are retained. | |||
* > 0, otherwise garbage packs are retained. | |||
*/ | |||
public long getGarbageTtlMillis() { | |||
return garbageTtlMillis; |
@@ -1448,7 +1448,7 @@ public class GC { | |||
* it exits without performing any work. Some JGit commands run | |||
* {@code gc --auto} after performing operations that could create many | |||
* loose objects. | |||
* <p/> | |||
* <p> | |||
* Housekeeping is required if there are too many loose objects or too many | |||
* packs in the repository. If the number of loose objects exceeds the value | |||
* of the gc.auto option JGit GC consolidates all existing packs into a | |||
@@ -1456,13 +1456,13 @@ public class GC { | |||
* combine all loose objects into a single pack using {@code repack -d -l}. | |||
* Setting the value of {@code gc.auto} to 0 disables automatic packing of | |||
* loose objects. | |||
* <p/> | |||
* <p> | |||
* If the number of packs exceeds the value of {@code gc.autoPackLimit}, | |||
* then existing packs (except those marked with a .keep file) are | |||
* consolidated into a single pack by using the {@code -A} option of repack. | |||
* Setting {@code gc.autoPackLimit} to 0 disables automatic consolidation of | |||
* packs. | |||
* <p/> | |||
* <p> | |||
* Like git the following jgit commands run auto gc: | |||
* <ul> | |||
* <li>fetch</li> |
@@ -159,7 +159,7 @@ public class BranchConfig { | |||
} | |||
/** | |||
* Get the remote this branch is configured to fetch from/push to> | |||
* Get the remote this branch is configured to fetch from/push to | |||
* | |||
* @return the remote this branch is configured to fetch from/push to, or | |||
* {@code null} if not defined |
@@ -1431,10 +1431,10 @@ public abstract class Repository implements AutoCloseable { | |||
* Normalizes the passed branch name into a possible valid branch name. The | |||
* validity of the returned name should be checked by a subsequent call to | |||
* {@link #isValidRefName(String)}. | |||
* <p/> | |||
* <p> | |||
* Future implementations of this method could be more restrictive or more | |||
* lenient about the validity of specific characters in the returned name. | |||
* <p/> | |||
* <p> | |||
* The current implementation returns the trimmed input string if this is | |||
* already a valid branch name. Otherwise it returns a trimmed string with | |||
* special characters not allowed by {@link #isValidRefName(String)} | |||
@@ -2079,7 +2079,7 @@ public abstract class Repository implements AutoCloseable { | |||
* collection; if not, exit without performing any work. Some JGit commands | |||
* run autoGC after performing operations that could create many loose | |||
* objects. | |||
* <p/> | |||
* <p> | |||
* Currently this option is supported for repositories of type | |||
* {@code FileRepository} only. See | |||
* {@link org.eclipse.jgit.internal.storage.file.GC#setAuto(boolean)} for |
@@ -81,7 +81,7 @@ import org.eclipse.jgit.util.FS; | |||
public class SubmoduleWalk implements AutoCloseable { | |||
/** | |||
* The values for the config param submodule.<name>.ignore | |||
* The values for the config parameter submodule.<name>.ignore | |||
* | |||
* @since 3.6 | |||
*/ |
@@ -63,8 +63,8 @@ import org.slf4j.LoggerFactory; | |||
/** | |||
* A representation of the "http.*" config values in a git | |||
* {@link org.eclipse.jgit.lib.Config}. git provides for setting values for | |||
* specific URLs through "http.<url>.* subsections. git always considers only | |||
* the initial original URL for such settings, not any redirected URL. | |||
* specific URLs through "http.<url>.*" subsections. git always considers | |||
* only the initial original URL for such settings, not any redirected URL. | |||
* | |||
* @since 4.9 | |||
*/ |
@@ -689,7 +689,7 @@ public class URIish implements Serializable { | |||
} | |||
/** | |||
* <Get the URI as an ASCII string. | |||
* Get the URI as an ASCII string. | |||
* | |||
* @return the URI as an ASCII string. Password is not included. | |||
*/ |
@@ -549,7 +549,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider { | |||
* <p> | |||
* Retrieve the git attributes for the current entry. | |||
* | |||
* <h4>Git attribute computation</h4> | |||
* <h3>Git attribute computation</h3> | |||
* | |||
* <ul> | |||
* <li>Get the attributes matching the current path entry from the info file | |||
@@ -568,7 +568,7 @@ public class TreeWalk implements AutoCloseable, AttributesProvider { | |||
* </ul> | |||
* | |||
* | |||
* <h4>Iterator constraints</h4> | |||
* <h3>Iterator constraints</h3> | |||
* | |||
* <p> | |||
* In order to have a correct list of attributes for the current entry, this |
@@ -575,7 +575,6 @@ public class FileUtils { | |||
* </pre> | |||
* | |||
* This will return "..\\another_project\\pom.xml". | |||
* </p> | |||
* | |||
* <p> | |||
* <b>Note</b> that this will return the empty String if <code>base</code> |
@@ -44,7 +44,7 @@ | |||
package org.eclipse.jgit.util; | |||
/** | |||
* Simple Map<long,Object>. | |||
* Simple Map<long, Object>. | |||
* | |||
* @param <V> | |||
* type of the value instance. |
@@ -107,7 +107,7 @@ public final class StringUtils { | |||
* {@link java.lang.Character#toTitleCase(char)}. No other letters are | |||
* changed. | |||
* </p> | |||
* | |||
* <p> | |||
* A <code>null</code> input String returns <code>null</code>. | |||
* </p> | |||
* |
@@ -70,6 +70,7 @@ public final class EolStreamTypeUtil { | |||
* <li>global attributes</li> | |||
* <li>info attributes</li> | |||
* <li>working tree .gitattributes</li> | |||
* </ul> | |||
* | |||
* @param op | |||
* is the |
@@ -65,7 +65,7 @@ import java.time.Duration; | |||
* } | |||
* | |||
* try (ProposedTimestamp t2 = clk.propose()) { | |||
* assert t2.millis() > r1; | |||
* assert t2.millis() > r1; | |||
* } | |||
* </pre> | |||
* |