Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Sohn2017-12-21 00:36:18 +0000
committerMatthias Sohn2017-12-21 01:42:14 +0000
commit2464fa440f7585154c591d3a12f6778026da40ff (patch)
treea0621370cecd9c7695aa983b7cd6d08dc7f1f092 /org.eclipse.jgit.lfs
parent73f8e887c3ca3a81d41ce0e33b139439098e9f26 (diff)
downloadjgit-2464fa440f7585154c591d3a12f6778026da40ff.tar.gz
jgit-2464fa440f7585154c591d3a12f6778026da40ff.tar.xz
jgit-2464fa440f7585154c591d3a12f6778026da40ff.zip
Fix remaining javadoc errors raised by doclint
For now ignore doclint "missing" warnings. Change-Id: I0e5af7a757f4d92ffeeb113f30576a35414d6781 Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit.lfs')
-rw-r--r--org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java2
-rw-r--r--org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java11
-rw-r--r--org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java9
3 files changed, 12 insertions, 10 deletions
diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java
index cee456ca2d..4a98286ddb 100644
--- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java
+++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/CleanFilter.java
@@ -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>'
+ * &lt;first-two-characters-of-contentid&gt;/&lt;rest-of-contentid&gt;'
*
* @see <a href="https://github.com/github/git-lfs/blob/master/docs/spec.md">Git
* LFS Specification</a>
diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java
index 7e6b99ed3f..138996d82f 100644
--- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java
+++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/Lfs.java
@@ -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();
diff --git a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java
index 6cec2bd37a..d5b96ab0fd 100644
--- a/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java
+++ b/org.eclipse.jgit.lfs/src/org/eclipse/jgit/lfs/lib/Constants.java
@@ -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";
}

Back to the top