Javadoc fixes
Skip javadoc generation for test bundles. Use character entities < and > for < and > outside of code-formatted spans. Change-Id: I66e1a1dc98881c61f93c9e5561c5513896b2ba01 Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
This commit is contained in:
parent
9446e62733
commit
a4542d06bb
|
@ -27,6 +27,10 @@
|
||||||
JUnit tests for the various ant tasks.
|
JUnit tests for the various ant tasks.
|
||||||
</description>
|
</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<maven.javadoc.skip>true</maven.javadoc.skip>
|
||||||
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>junit</groupId>
|
<groupId>junit</groupId>
|
||||||
|
|
|
@ -27,6 +27,10 @@
|
||||||
Tests for the LFS server.
|
Tests for the LFS server.
|
||||||
</description>
|
</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<maven.javadoc.skip>true</maven.javadoc.skip>
|
||||||
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>junit</groupId>
|
<groupId>junit</groupId>
|
||||||
|
|
|
@ -27,6 +27,10 @@
|
||||||
Tests for the Large File Extension (LFS).
|
Tests for the Large File Extension (LFS).
|
||||||
</description>
|
</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<maven.javadoc.skip>true</maven.javadoc.skip>
|
||||||
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>junit</groupId>
|
<groupId>junit</groupId>
|
||||||
|
|
|
@ -27,6 +27,10 @@
|
||||||
Tests for command line client tools built on top of JGit.
|
Tests for command line client tools built on top of JGit.
|
||||||
</description>
|
</description>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<maven.javadoc.skip>true</maven.javadoc.skip>
|
||||||
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>junit</groupId>
|
<groupId>junit</groupId>
|
||||||
|
|
|
@ -71,9 +71,9 @@ public class JGitClientSession extends ClientSessionImpl {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Default setting for the maximum number of bytes to read in the initial
|
* 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
|
* protocol version exchange. 64kb is what OpenSSH < 8.0 read; OpenSSH
|
||||||
* changed it to 8Mb, but that seems excessive for the purpose stated in RFC
|
* 8.0 changed it to 8Mb, but that seems excessive for the purpose stated in
|
||||||
* 4253. The Apache MINA sshd default in
|
* RFC 4253. The Apache MINA sshd default in
|
||||||
* {@link org.apache.sshd.core.CoreModuleProperties#MAX_IDENTIFICATION_SIZE}
|
* {@link org.apache.sshd.core.CoreModuleProperties#MAX_IDENTIFICATION_SIZE}
|
||||||
* is 16kb.
|
* is 16kb.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -105,7 +105,7 @@ protected void init(ClientSession session) {
|
||||||
/**
|
/**
|
||||||
* Obtains the timeout for the whole rest of the proxy connection protocol.
|
* 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 > 0L
|
||||||
*/
|
*/
|
||||||
protected long getTimeout() {
|
protected long getTimeout() {
|
||||||
long last = lastProxyOperationTime;
|
long last = lastProxyOperationTime;
|
||||||
|
|
|
@ -31,7 +31,7 @@ public interface KeyPasswordProvider {
|
||||||
* identifying the key resource that is being attempted to be
|
* identifying the key resource that is being attempted to be
|
||||||
* loaded
|
* loaded
|
||||||
* @param attempt
|
* @param attempt
|
||||||
* the number of previous attempts to get a passphrase; >= 0
|
* the number of previous attempts to get a passphrase; >= 0
|
||||||
* @return the passphrase
|
* @return the passphrase
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* if no password can be obtained
|
* if no password can be obtained
|
||||||
|
@ -44,7 +44,7 @@ public interface KeyPasswordProvider {
|
||||||
*
|
*
|
||||||
* @param maxNumberOfAttempts
|
* @param maxNumberOfAttempts
|
||||||
* number of times to ask for a passphrase;
|
* number of times to ask for a passphrase;
|
||||||
* {@link IllegalArgumentException} may be thrown if <= 0
|
* {@link IllegalArgumentException} may be thrown if <= 0
|
||||||
*/
|
*/
|
||||||
void setAttempts(int maxNumberOfAttempts);
|
void setAttempts(int maxNumberOfAttempts);
|
||||||
|
|
||||||
|
@ -53,7 +53,7 @@ public interface KeyPasswordProvider {
|
||||||
* attempted for one identity resource through this provider. The default
|
* attempted for one identity resource through this provider. The default
|
||||||
* return 1.
|
* 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 >= 1.
|
||||||
*/
|
*/
|
||||||
default int getAttempts() {
|
default int getAttempts() {
|
||||||
return 1;
|
return 1;
|
||||||
|
|
|
@ -71,12 +71,12 @@ class Candidate {
|
||||||
/**
|
/**
|
||||||
* Score assigned to the rename to this candidate.
|
* Score assigned to the rename to this candidate.
|
||||||
* <p>
|
* <p>
|
||||||
* Consider the history "A<-B<-C". If the result file S in C was renamed to
|
* Consider the history "A<-B<-C". If the result file S in C was
|
||||||
* R in B, the rename score for this rename will be held in this field by
|
* renamed to R in B, the rename score for this rename will be held in this
|
||||||
* the candidate object for B. By storing the score with B, the application
|
* field by the candidate object for B. By storing the score with B, the
|
||||||
* can see what the rename score was as it makes the transition from C/S to
|
* application can see what the rename score was as it makes the transition
|
||||||
* B/R. This may seem backwards since it was C that performed the rename,
|
* from C/S to B/R. This may seem backwards since it was C that performed
|
||||||
* but the application doesn't learn about path R until B.
|
* the rename, but the application doesn't learn about path R until B.
|
||||||
*/
|
*/
|
||||||
int renameScore;
|
int renameScore;
|
||||||
|
|
||||||
|
|
|
@ -27,7 +27,7 @@ class Region {
|
||||||
/** First position in the {@link Candidate} that owns this Region. */
|
/** First position in the {@link Candidate} that owns this Region. */
|
||||||
int sourceStart;
|
int sourceStart;
|
||||||
|
|
||||||
/** Length of the region, always >= 1. */
|
/** Length of the region, always >= 1. */
|
||||||
int length;
|
int length;
|
||||||
|
|
||||||
Region(int rs, int ss, int len) {
|
Region(int rs, int ss, int len) {
|
||||||
|
|
|
@ -280,12 +280,12 @@ public String getPathString() {
|
||||||
* number of bytes of <code>cache[cacheIdx].path</code> that
|
* number of bytes of <code>cache[cacheIdx].path</code> that
|
||||||
* matches this tree's path. The value at array position
|
* matches this tree's path. The value at array position
|
||||||
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
|
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
|
||||||
* <code>pathOff</code> is > 0.
|
* <code>pathOff</code> is > 0.
|
||||||
* @param ow
|
* @param ow
|
||||||
* the writer to use when serializing to the store.
|
* the writer to use when serializing to the store.
|
||||||
* @return identity of this tree.
|
* @return identity of this tree.
|
||||||
* @throws UnmergedPathException
|
* @throws UnmergedPathException
|
||||||
* one or more paths contain higher-order stages (stage > 0),
|
* one or more paths contain higher-order stages (stage > 0),
|
||||||
* which cannot be stored in a tree object.
|
* which cannot be stored in a tree object.
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* an unexpected error occurred writing to the object store.
|
* 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
|
* number of bytes of <code>cache[cacheIdx].path</code> that
|
||||||
* matches this tree's path. The value at array position
|
* matches this tree's path. The value at array position
|
||||||
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
|
* <code>cache[cacheIdx].path[pathOff-1]</code> is always '/' if
|
||||||
* <code>pathOff</code> is > 0.
|
* <code>pathOff</code> is > 0.
|
||||||
*/
|
*/
|
||||||
void validate(final DirCacheEntry[] cache, final int cCnt, int cIdx,
|
void validate(final DirCacheEntry[] cache, final int cCnt, int cIdx,
|
||||||
final int pathOff) {
|
final int pathOff) {
|
||||||
|
|
|
@ -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 > gc.autopacklimit (default
|
||||||
|
* 50)
|
||||||
*/
|
*/
|
||||||
boolean tooManyPacks() {
|
boolean tooManyPacks() {
|
||||||
int autopacklimit = repo.getConfig().getInt(
|
int autopacklimit = repo.getConfig().getInt(
|
||||||
|
@ -1549,7 +1550,8 @@ boolean tooManyPacks() {
|
||||||
* Quickly estimate number of loose objects, SHA1 is distributed evenly so
|
* Quickly estimate number of loose objects, SHA1 is distributed evenly so
|
||||||
* counting objects in one directory (bucket 17) is sufficient
|
* 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 > gc.auto (default
|
||||||
|
* 6700)
|
||||||
*/
|
*/
|
||||||
boolean tooManyLooseObjects() {
|
boolean tooManyLooseObjects() {
|
||||||
int auto = getLooseObjectLimit();
|
int auto = getLooseObjectLimit();
|
||||||
|
|
|
@ -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
|
* real host name, or it may just be a "Host" block in the
|
||||||
* configuration file.
|
* configuration file.
|
||||||
* @param port
|
* @param port
|
||||||
* the user supplied; <= 0 if none
|
* the user supplied; <= 0 if none
|
||||||
* @param userName
|
* @param userName
|
||||||
* the user supplied, may be {@code null} or empty if none given
|
* the user supplied, may be {@code null} or empty if none given
|
||||||
* @return the configuration for the requested name.
|
* @return the configuration for the requested name.
|
||||||
|
|
|
@ -28,7 +28,7 @@ public interface SshConfigStore {
|
||||||
* @param hostName
|
* @param hostName
|
||||||
* to look up
|
* to look up
|
||||||
* @param port
|
* @param port
|
||||||
* the user supplied; <= 0 if none
|
* the user supplied; <= 0 if none
|
||||||
* @param userName
|
* @param userName
|
||||||
* the user supplied, may be {@code null} or empty if none given
|
* the user supplied, may be {@code null} or empty if none given
|
||||||
* @return the configuration for the requested name.
|
* @return the configuration for the requested name.
|
||||||
|
@ -68,7 +68,7 @@ public interface SshConfigStore {
|
||||||
* @param hostName
|
* @param hostName
|
||||||
* host name to look up
|
* host name to look up
|
||||||
* @param port
|
* @param port
|
||||||
* port number; <= 0 if none
|
* port number; <= 0 if none
|
||||||
* @param userName
|
* @param userName
|
||||||
* the user name, may be {@code null} or empty if none given
|
* the user name, may be {@code null} or empty if none given
|
||||||
* @return the configuration for the requested name.
|
* @return the configuration for the requested name.
|
||||||
|
|
Loading…
Reference in New Issue