aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit
diff options
context:
space:
mode:
authorThomas Wolf <thomas.wolf@paranor.ch>2021-11-22 11:47:21 +0100
committerMatthias Sohn <matthias.sohn@sap.com>2021-11-22 17:45:46 -0500
commita4542d06bbd6f635f0ac9ebf8df4f9fd5efdccdf (patch)
treeb579b4039d7127d99c60d61acd7587b8a5f232d5 /org.eclipse.jgit
parent9446e62733da5005be1d5182f0dce759a3052d4a (diff)
downloadjgit-a4542d06bbd6f635f0ac9ebf8df4f9fd5efdccdf.tar.gz
jgit-a4542d06bbd6f635f0ac9ebf8df4f9fd5efdccdf.zip
Javadoc fixes
Skip javadoc generation for test bundles. Use character entities &lt; and &gt; for < and > outside of code-formatted spans. Change-Id: I66e1a1dc98881c61f93c9e5561c5513896b2ba01 Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
Diffstat (limited to 'org.eclipse.jgit')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java12
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java2
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java6
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java6
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java2
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java4
6 files changed, 17 insertions, 15 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java b/org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java
index b69bb8f3ee..ca5370e912 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java
@@ -71,12 +71,12 @@ class Candidate {
/**
* Score assigned to the rename to this candidate.
* <p>
- * Consider the history "A<-B<-C". If the result file S in C was renamed to
- * R in B, the rename score for this rename will be held in this field by
- * the candidate object for B. By storing the score with B, the application
- * can see what the rename score was as it makes the transition from C/S to
- * B/R. This may seem backwards since it was C that performed the rename,
- * but the application doesn't learn about path R until B.
+ * Consider the history "A&lt;-B&lt;-C". If the result file S in C was
+ * renamed to R in B, the rename score for this rename will be held in this
+ * field by the candidate object for B. By storing the score with B, the
+ * application can see what the rename score was as it makes the transition
+ * from C/S to B/R. This may seem backwards since it was C that performed
+ * the rename, but the application doesn't learn about path R until B.
*/
int renameScore;
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java b/org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java
index e226dbf3cc..2236eecbfe 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java
@@ -27,7 +27,7 @@ class Region {
/** First position in the {@link Candidate} that owns this Region. */
int sourceStart;
- /** Length of the region, always >= 1. */
+ /** Length of the region, always &gt;= 1. */
int length;
Region(int rs, int ss, int len) {
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java
index 07162db4ce..e0c1e93918 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java
@@ -280,12 +280,12 @@ public class DirCacheTree {
* number of bytes of <code>cache[cacheIdx].path</code> that
* matches this tree's path. The value at array position
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
- * <code>pathOff</code> is > 0.
+ * <code>pathOff</code> is &gt; 0.
* @param ow
* the writer to use when serializing to the store.
* @return identity of this tree.
* @throws UnmergedPathException
- * one or more paths contain higher-order stages (stage > 0),
+ * one or more paths contain higher-order stages (stage &gt; 0),
* which cannot be stored in a tree object.
* @throws IOException
* an unexpected error occurred writing to the object store.
@@ -401,7 +401,7 @@ public class DirCacheTree {
* number of bytes of <code>cache[cacheIdx].path</code> that
* matches this tree's path. The value at array position
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
- * <code>pathOff</code> is > 0.
+ * <code>pathOff</code> is &gt; 0.
*/
void validate(final DirCacheEntry[] cache, final int cCnt, int cIdx,
final int pathOff) {
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
index 40c075ec5e..93c6201597 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
@@ -1530,7 +1530,8 @@ public class GC {
}
/**
- * @return {@code true} if number of packs > gc.autopacklimit (default 50)
+ * @return {@code true} if number of packs &gt; gc.autopacklimit (default
+ * 50)
*/
boolean tooManyPacks() {
int autopacklimit = repo.getConfig().getInt(
@@ -1549,7 +1550,8 @@ public class GC {
* Quickly estimate number of loose objects, SHA1 is distributed evenly so
* counting objects in one directory (bucket 17) is sufficient
*
- * @return {@code true} if number of loose objects > gc.auto (default 6700)
+ * @return {@code true} if number of loose objects &gt; gc.auto (default
+ * 6700)
*/
boolean tooManyLooseObjects() {
int auto = getLooseObjectLimit();
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java b/org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java
index 2dbb7859b9..648d4a1821 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java
@@ -142,7 +142,7 @@ public class OpenSshConfigFile implements SshConfigStore {
* real host name, or it may just be a "Host" block in the
* configuration file.
* @param port
- * the user supplied; <= 0 if none
+ * the user supplied; &lt;= 0 if none
* @param userName
* the user supplied, may be {@code null} or empty if none given
* @return the configuration for the requested name.
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java
index d98bd2307f..1226a6b5ea 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java
@@ -28,7 +28,7 @@ public interface SshConfigStore {
* @param hostName
* to look up
* @param port
- * the user supplied; <= 0 if none
+ * the user supplied; &lt;= 0 if none
* @param userName
* the user supplied, may be {@code null} or empty if none given
* @return the configuration for the requested name.
@@ -68,7 +68,7 @@ public interface SshConfigStore {
* @param hostName
* host name to look up
* @param port
- * port number; <= 0 if none
+ * port number; &lt;= 0 if none
* @param userName
* the user name, may be {@code null} or empty if none given
* @return the configuration for the requested name.