motiejus
/
jgit
1
Fork 0
Code Releases Activity

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>
This commit is contained in:
Thomas Wolf 2021-11-22 11:47:21 +01:00 committed by Matthias Sohn
parent 9446e62733
commit a4542d06bb
13 changed files with 40 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
org.eclipse.jgit.ant.test/pom.xml
View File

@ -27,6 +27,10 @@
JUnit tests for the various ant tasks.
</description>
<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>

4
org.eclipse.jgit.lfs.server.test/pom.xml
View File

@ -27,6 +27,10 @@
Tests for the LFS server.
</description>
<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>

4
org.eclipse.jgit.lfs.test/pom.xml
View File

@ -27,6 +27,10 @@
Tests for the Large File Extension (LFS).
</description>
<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>

4
org.eclipse.jgit.pgm.test/pom.xml
View File

@ -27,6 +27,10 @@
Tests for command line client tools built on top of JGit.
</description>
<properties>
<maven.javadoc.skip>true</maven.javadoc.skip>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>

6
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/JGitClientSession.java
View File

@ -71,9 +71,9 @@ public class JGitClientSession extends ClientSessionImpl {
/**
* Default setting for the maximum number of bytes to read in the initial
* protocol version exchange. 64kb is what OpenSSH < 8.0 read; OpenSSH 8.0
* changed it to 8Mb, but that seems excessive for the purpose stated in RFC
* 4253. The Apache MINA sshd default in
* protocol version exchange. 64kb is what OpenSSH &lt; 8.0 read; OpenSSH
* 8.0 changed it to 8Mb, but that seems excessive for the purpose stated in
* RFC 4253. The Apache MINA sshd default in
* {@link org.apache.sshd.core.CoreModuleProperties#MAX_IDENTIFICATION_SIZE}
* is 16kb.
*/

2
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/proxy/AbstractClientProxyConnector.java
View File

@ -105,7 +105,7 @@ protected void init(ClientSession session) {
/**
* Obtains the timeout for the whole rest of the proxy connection protocol.
*
* @return the timeout in milliseconds, always > 0L
* @return the timeout in milliseconds, always &gt; 0L
*/
protected long getTimeout() {
long last = lastProxyOperationTime;

6
org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/KeyPasswordProvider.java
View File

@ -31,7 +31,7 @@ public interface KeyPasswordProvider {
* identifying the key resource that is being attempted to be
* loaded
* @param attempt
* the number of previous attempts to get a passphrase; >= 0
* the number of previous attempts to get a passphrase; &gt;= 0
* @return the passphrase
* @throws IOException
* if no password can be obtained
@ -44,7 +44,7 @@ public interface KeyPasswordProvider {
*
* @param maxNumberOfAttempts
* number of times to ask for a passphrase;
* {@link IllegalArgumentException} may be thrown if <= 0
* {@link IllegalArgumentException} may be thrown if &lt;= 0
*/
void setAttempts(int maxNumberOfAttempts);
@ -53,7 +53,7 @@ public interface KeyPasswordProvider {
* attempted for one identity resource through this provider. The default
* return 1.
*
* @return the number of times to ask for a passphrase; should be >= 1.
* @return the number of times to ask for a passphrase; should be &gt;= 1.
*/
default int getAttempts() {
return 1;

12
org.eclipse.jgit/src/org/eclipse/jgit/blame/Candidate.java
View File

@ -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;

2
org.eclipse.jgit/src/org/eclipse/jgit/blame/Region.java
View File

@ -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) {

6
org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheTree.java
View File

@ -280,12 +280,12 @@ public String getPathString() {
* 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 @@ final boolean contains(byte[] a, int aOff, int aLen) {
* 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) {

6
org.eclipse.jgit/src/org/eclipse/jgit/internal/storage/file/GC.java
View File

@ -1530,7 +1530,8 @@ private void addRepackAllOption() {
}
/**
* @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 @@ boolean tooManyPacks() {
* 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();

2
org.eclipse.jgit/src/org/eclipse/jgit/internal/transport/ssh/OpenSshConfigFile.java
View File

@ -142,7 +142,7 @@ public OpenSshConfigFile(@NonNull File home, @NonNull File config,
* 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.

4
org.eclipse.jgit/src/org/eclipse/jgit/transport/SshConfigStore.java
View File

@ -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.