Cleanup javadocs so they pass the java8 doclint checks

Bug: 431552
Change-Id: I469316f5645205016e1fa6b0fbd2ff3b509b14bc
Signed-off-by: Robin Stocker <robin@nibor.org>
This commit is contained in:
Robin Rosenberg 2014-03-29 10:29:29 +01:00 committed by Robin Stocker
parent 20fc105021
commit 32ff57a2b2
35 changed files with 102 additions and 84 deletions

View File

@ -131,7 +131,7 @@ private static int[] grow(int[] tmp) {
* first parsed version string. * first parsed version string.
* @param b * @param b
* second parsed version string. * second parsed version string.
* @return <0 if a is before b; 0 if a equals b; >0 if a is after b. * @return &lt; 0 if a is before b; 0 if a equals b; &gt;0 if a is after b.
*/ */
public static int compare(int[] a, int[] b) { public static int compare(int[] a, int[] b) {
for (int i = 0; i < a.length && i < b.length; i++) { for (int i = 0; i < a.length && i < b.length; i++) {

View File

@ -74,7 +74,7 @@
* <li>Commit graph and short message</li> * <li>Commit graph and short message</li>
* <li>Author name and email address</li> * <li>Author name and email address</li>
* <li>Author date and time</li> * <li>Author date and time</li>
* </ul> * </ol>
*/ */
public class CommitGraphPane extends JTable { public class CommitGraphPane extends JTable {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

View File

@ -142,7 +142,7 @@ public DescribeCommand setTarget(String rev) throws IOException,
* @return if there's a tag that points to the commit being described, this * @return if there's a tag that points to the commit being described, this
* tag name is returned. Otherwise additional suffix is added to the * tag name is returned. Otherwise additional suffix is added to the
* nearest tag, just like git-describe(1). * nearest tag, just like git-describe(1).
* <p/> * <p>
* If none of the ancestors of the commit being described has any * If none of the ancestors of the commit being described has any
* tags at all, then this method returns null, indicating that * tags at all, then this method returns null, indicating that
* there's no way to describe this tag. * there's no way to describe this tag.

View File

@ -107,7 +107,7 @@ public class MergeCommand extends GitCommand<MergeResult> {
/** /**
* The modes available for fast forward merges corresponding to the * The modes available for fast forward merges corresponding to the
* <code>--ff</code>, <code>--no-ff</code> and <code>--ff-only</code> * <code>--ff</code>, <code>--no-ff</code> and <code>--ff-only</code>
* options under <code>branch.<name>.mergeoptions</code>. * options under <code>branch.&lt;name&gt;.mergeoptions</code>.
*/ */
public enum FastForwardMode implements ConfigEnum { public enum FastForwardMode implements ConfigEnum {
/** /**
@ -162,7 +162,7 @@ public enum Merge {
* *
* @param ffMode * @param ffMode
* the <code>FastForwardMode</code> value to be mapped * the <code>FastForwardMode</code> value to be mapped
* @return the mapped code>FastForwardMode.Merge</code> value * @return the mapped <code>FastForwardMode.Merge</code> value
*/ */
public static Merge valueOf(FastForwardMode ffMode) { public static Merge valueOf(FastForwardMode ffMode) {
switch (ffMode) { switch (ffMode) {
@ -182,7 +182,7 @@ public static Merge valueOf(FastForwardMode ffMode) {
* *
* @param ffMode * @param ffMode
* the <code>FastForwardMode.Merge</code> value to be mapped * the <code>FastForwardMode.Merge</code> value to be mapped
* @return the mapped code>FastForwardMode</code> value * @return the mapped <code>FastForwardMode</code> value
*/ */
public static FastForwardMode valueOf(FastForwardMode.Merge ffMode) { public static FastForwardMode valueOf(FastForwardMode.Merge ffMode) {
switch (ffMode) { switch (ffMode) {

View File

@ -464,32 +464,36 @@ public void addConflict(String path, org.eclipse.jgit.merge.MergeResult<?> lowLe
* file to a two-dimensional int-array of line-numbers telling where in the * file to a two-dimensional int-array of line-numbers telling where in the
* file conflict markers for which merged commit can be found. * file conflict markers for which merged commit can be found.
* <p> * <p>
* If the returned value contains a mapping "path"->[x][y]=z then this means * If the returned value contains a mapping "path"-&gt;[x][y]=z then this
* means
* <ul> * <ul>
* <li>the file with path "path" contains conflicts</li> * <li>the file with path "path" contains conflicts</li>
* <li>if y < "number of merged commits": for conflict number x in this file * <li>if y &lt; "number of merged commits": for conflict number x in this
* the chunk which was copied from commit number y starts on line number z. * file the chunk which was copied from commit number y starts on line
* All numberings and line numbers start with 0.</li> * number z. All numberings and line numbers start with 0.</li>
* <li>if y == "number of merged commits": the first non-conflicting line * <li>if y == "number of merged commits": the first non-conflicting line
* after conflict number x starts at line number z</li> * after conflict number x starts at line number z</li>
* </ul> * </ul>
* <p> * <p>
* Example code how to parse this data: * Example code how to parse this data:
* <pre> MergeResult m=...; *
* Map<String, int[][]> allConflicts = m.getConflicts(); * <pre>
* MergeResult m=...;
* Map&lt;String, int[][]&gt; allConflicts = m.getConflicts();
* for (String path : allConflicts.keySet()) { * for (String path : allConflicts.keySet()) {
* int[][] c = allConflicts.get(path); * int[][] c = allConflicts.get(path);
* System.out.println("Conflicts in file " + path); * System.out.println("Conflicts in file " + path);
* for (int i = 0; i < c.length; ++i) { * for (int i = 0; i < c.length; ++i) {
* System.out.println(" Conflict #" + i); * System.out.println(" Conflict #" + i);
* for (int j = 0; j < (c[i].length) - 1; ++j) { * for (int j = 0; j &lt; (c[i].length) - 1; ++j) {
* if (c[i][j] >= 0) * if (c[i][j] >= 0)
* System.out.println(" Chunk for " * System.out.println(" Chunk for "
* + m.getMergedCommits()[j] + " starts on line #" * + m.getMergedCommits()[j] + " starts on line #"
* + c[i][j]); * + c[i][j]);
* } * }
* } * }
* }</pre> * }
* </pre>
* *
* @return the conflicts or <code>null</code> if no conflict occurred * @return the conflicts or <code>null</code> if no conflict occurred
*/ */

View File

@ -111,16 +111,18 @@ public PullCommand setProgressMonitor(ProgressMonitor monitor) {
/** /**
* Set if rebase should be used after fetching. If set to true, rebase is * Set if rebase should be used after fetching. If set to true, rebase is
* used instead of merge. This is equivalent to --rebase on the command line. * used instead of merge. This is equivalent to --rebase on the command
* <p/> * line.
* If set to false, merge is used after fetching, overriding the configuration * <p>
* file. This is equivalent to --no-rebase on the command line. * If set to false, merge is used after fetching, overriding the
* <p/> * configuration file. This is equivalent to --no-rebase on the command
* This setting overrides the settings in the configuration file. * line.
* By default, the setting in the repository configuration file is used. * <p>
* <p/> * This setting overrides the settings in the configuration file. By
* A branch can be configured to use rebase by default. * default, the setting in the repository configuration file is used.
* See branch.[name].rebase and branch.autosetuprebase. * <p>
* A branch can be configured to use rebase by default. See
* branch.[name].rebase and branch.autosetuprebase.
* *
* @param useRebase * @param useRebase
* @return {@code this} * @return {@code this}

View File

@ -372,7 +372,7 @@ public String getOldPath() {
* <li><i>file modify</i>: always {@link #getOldPath()}</li> * <li><i>file modify</i>: always {@link #getOldPath()}</li>
* <li><i>file delete</i>: always <code>/dev/null</code></li> * <li><i>file delete</i>: always <code>/dev/null</code></li>
* <li><i>file copy</i>: destination file the copy ends up at</li> * <li><i>file copy</i>: destination file the copy ends up at</li>
* <li><i>file rename</i>: destination file the rename ends up at/li> * <li><i>file rename</i>: destination file the rename ends up at</li>
* </ul> * </ul>
* *
* @return new name for this file. * @return new name for this file.
@ -453,7 +453,7 @@ public AbbreviatedObjectId getNewId() {
* <pre> * <pre>
* TreeFilter filterA = ...; * TreeFilter filterA = ...;
* TreeFilter filterB = ...; * TreeFilter filterB = ...;
* List<DiffEntry> entries = DiffEntry.scan(walk, false, filterA, filterB); * List&lt;DiffEntry&gt; entries = DiffEntry.scan(walk, false, filterA, filterB);
* DiffEntry entry = entries.get(0); * DiffEntry entry = entries.get(0);
* boolean filterAMatched = entry.isMarked(0); * boolean filterAMatched = entry.isMarked(0);
* boolean filterBMatched = entry.isMarked(1); * boolean filterBMatched = entry.isMarked(1);

View File

@ -51,16 +51,16 @@
* Regions should be specified using 0 based notation, so add 1 to the start and * Regions should be specified using 0 based notation, so add 1 to the start and
* end marks for line numbers in a file. * end marks for line numbers in a file.
* <p> * <p>
* An edit where <code>beginA == endA && beginB < endB</code> is an insert edit, * An edit where <code>beginA == endA && beginB &lt; endB</code> is an insert
* that is sequence B inserted the elements in region * edit, that is sequence B inserted the elements in region
* <code>[beginB, endB)</code> at <code>beginA</code>. * <code>[beginB, endB)</code> at <code>beginA</code>.
* <p> * <p>
* An edit where <code>beginA < endA && beginB == endB</code> is a delete edit, * An edit where <code>beginA &lt; endA && beginB == endB</code> is a delete
* that is sequence B has removed the elements between * edit, that is sequence B has removed the elements between
* <code>[beginA, endA)</code>. * <code>[beginA, endA)</code>.
* <p> * <p>
* An edit where <code>beginA < endA && beginB < endB</code> is a replace edit, * An edit where <code>beginA &lt; endA && beginB &lt; endB</code> is a replace
* that is sequence B has replaced the range of elements between * edit, that is sequence B has replaced the range of elements between
* <code>[beginA, endA)</code> with those found in <code>[beginB, endB)</code>. * <code>[beginA, endA)</code> with those found in <code>[beginB, endB)</code>.
*/ */
public class Edit { public class Edit {
@ -105,11 +105,11 @@ public Edit(final int as, final int bs) {
* @param as * @param as
* beginA: start of region in sequence A; 0 based. * beginA: start of region in sequence A; 0 based.
* @param ae * @param ae
* endA: end of region in sequence A; must be >= as. * endA: end of region in sequence A; must be &gt;= as.
* @param bs * @param bs
* beginB: start of region in sequence B; 0 based. * beginB: start of region in sequence B; 0 based.
* @param be * @param be
* endB: end of region in sequence B; must be >= bs. * endB: end of region in sequence B; must be &gt; = bs.
*/ */
public Edit(final int as, final int ae, final int bs, final int be) { public Edit(final int as, final int ae, final int bs, final int be) {
beginA = as; beginA = as;

View File

@ -167,11 +167,21 @@ private void calculateEdits(Edit r) {
} }
/** /**
* Calculates the differences between a given part of A against another given part of B * Calculates the differences between a given part of A against another
* @param beginA start of the part of A which should be compared (0<=beginA<sizeof(A)) * given part of B
* @param endA end of the part of A which should be compared (beginA<=endA<sizeof(A)) *
* @param beginB start of the part of B which should be compared (0<=beginB<sizeof(B)) * @param beginA
* @param endB end of the part of B which should be compared (beginB<=endB<sizeof(B)) * start of the part of A which should be compared
* (0&lt;=beginA&lt;sizeof(A))
* @param endA
* end of the part of A which should be compared
* (beginA&lt;=endA&lt;sizeof(A))
* @param beginB
* start of the part of B which should be compared
* (0&lt;=beginB&lt;sizeof(B))
* @param endB
* end of the part of B which should be compared
* (beginB&lt;=endB&lt;sizeof(B))
*/ */
protected void calculateEdits(int beginA, int endA, protected void calculateEdits(int beginA, int endA,
int beginB, int endB) { int beginB, int endB) {

View File

@ -730,14 +730,14 @@ public void unlock() {
} }
/** /**
* Locate the position a path's entry is at in the index. * Locate the position a path's entry is at in the index. For details refer
* For details refer to #findEntry(byte[], int). * to #findEntry(byte[], int).
* *
* @param path * @param path
* the path to search for. * the path to search for.
* @return if >= 0 then the return value is the position of the entry in the * @return if &gt;= 0 then the return value is the position of the entry in
* index; pass to {@link #getEntry(int)} to obtain the entry * the index; pass to {@link #getEntry(int)} to obtain the entry
* information. If < 0 the entry does not exist in the index. * information. If &lt; 0 the entry does not exist in the index.
*/ */
public int findEntry(final String path) { public int findEntry(final String path) {
final byte[] p = Constants.encode(path); final byte[] p = Constants.encode(path);
@ -758,9 +758,9 @@ public int findEntry(final String path) {
* the byte array starting with the path to search for. * the byte array starting with the path to search for.
* @param pLen * @param pLen
* the length of the path in bytes * the length of the path in bytes
* @return if >= 0 then the return value is the position of the entry in the * @return if &gt;= 0 then the return value is the position of the entry in
* index; pass to {@link #getEntry(int)} to obtain the entry * the index; pass to {@link #getEntry(int)} to obtain the entry
* information. If < 0 the entry does not exist in the index. * information. If &lt; 0 the entry does not exist in the index.
* @since 3.4 * @since 3.4
*/ */
public int findEntry(final byte[] p, final int pLen) { public int findEntry(final byte[] p, final int pLen) {
@ -917,7 +917,7 @@ public DirCacheTree getCacheTree(final boolean build) {
* returned tree identity. * returned tree identity.
* @return identity for the root tree. * @return identity for the root tree.
* @throws UnmergedPathException * @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. * which cannot be stored in a tree object.
* @throws IllegalStateException * @throws IllegalStateException
* one or more paths contain an invalid mode which should never * one or more paths contain an invalid mode which should never

View File

@ -548,7 +548,7 @@ public void setLastModified(final long when) {
* <p> * <p>
* Note that this is the length of the file in the working directory, which * Note that this is the length of the file in the working directory, which
* may differ from the size of the decompressed blob if work tree filters * may differ from the size of the decompressed blob if work tree filters
* are being used, such as LF<->CRLF conversion. * are being used, such as LF&lt;-&gt;CRLF conversion.
* <p> * <p>
* Note also that for very large files, this is the size of the on-disk file * Note also that for very large files, this is the size of the on-disk file
* truncated to 32 bits, i.e. modulo 4294967296. If that value is larger * truncated to 32 bits, i.e. modulo 4294967296. If that value is larger

View File

@ -80,7 +80,6 @@
* </ul> * </ul>
* e. g. [[:xdigit:]]</li> * e. g. [[:xdigit:]]</li>
* </ul> * </ul>
* </p>
* Any character can be escaped by prepending it with a \ * Any character can be escaped by prepending it with a \
*/ */
public class FileNameMatcher { public class FileNameMatcher {

View File

@ -132,11 +132,13 @@
* <li>by providing iterator of {@link RevObject} specifying exact list and * <li>by providing iterator of {@link RevObject} specifying exact list and
* order of objects in pack</li> * order of objects in pack</li>
* </ul> * </ul>
* <p>
* Typical usage consists of creating instance intended for some pack, * Typical usage consists of creating instance intended for some pack,
* configuring options, preparing the list of objects by calling * configuring options, preparing the list of objects by calling
* {@link #preparePack(Iterator)} or * {@link #preparePack(Iterator)} or
* {@link #preparePack(ProgressMonitor, Collection, Collection)}, and finally * {@link #preparePack(ProgressMonitor, Collection, Collection)}, and finally
* producing the stream with {@link #writePack(ProgressMonitor, ProgressMonitor, OutputStream)}. * producing the stream with
* {@link #writePack(ProgressMonitor, ProgressMonitor, OutputStream)}.
* </p> * </p>
* <p> * <p>
* Class provide set of configurable options and {@link ProgressMonitor} * Class provide set of configurable options and {@link ProgressMonitor}

View File

@ -325,7 +325,7 @@ public final int prefixCompare(final int[] bs, final int p) {
return NB.compareUInt32(w5, mask(5, bs[p + 4])); return NB.compareUInt32(w5, mask(5, bs[p + 4]));
} }
/** @return value for a fan-out style map, only valid of length >= 2. */ /** @return value for a fan-out style map, only valid of length &gt;= 2. */
public final int getFirstByte() { public final int getFirstByte() {
return w1 >>> 24; return w1 >>> 24;
} }

View File

@ -156,8 +156,8 @@ public final int getByte(int index) {
* *
* @param other * @param other
* the other id to compare to. Must not be null. * the other id to compare to. Must not be null.
* @return < 0 if this id comes before other; 0 if this id is equal to * @return &lt; 0 if this id comes before other; 0 if this id is equal to
* other; > 0 if this id comes after other. * other; &gt; 0 if this id comes after other.
*/ */
public final int compareTo(final AnyObjectId other) { public final int compareTo(final AnyObjectId other) {
if (this == other) if (this == other)

View File

@ -64,13 +64,13 @@ public CoreConfig parse(final Config cfg) {
/** Permissible values for {@code core.autocrlf}. */ /** Permissible values for {@code core.autocrlf}. */
public static enum AutoCRLF { public static enum AutoCRLF {
/** Automatic CRLF->LF conversion is disabled. */ /** Automatic CRLF-&gt;LF conversion is disabled. */
FALSE, FALSE,
/** Automatic CRLF->LF conversion is enabled. */ /** Automatic CRLF-&gt;LF conversion is enabled. */
TRUE, TRUE,
/** CRLF->LF performed, but no LF->CRLF. */ /** CRLF-&gt;LF performed, but no LF-&gt;CRLF. */
INPUT; INPUT;
} }

View File

@ -84,7 +84,7 @@ public static Collection<Ref> sort(final Collection<Ref> refs) {
* the reference instance. * the reference instance.
* @param o2 * @param o2
* the name to compare to. * the name to compare to.
* @return standard Comparator result of < 0, 0, > 0. * @return standard Comparator result of &lt; 0, 0, &gt; 0.
*/ */
public static int compareTo(Ref o1, String o2) { public static int compareTo(Ref o1, String o2) {
return o1.getName().compareTo(o2); return o1.getName().compareTo(o2);
@ -97,7 +97,7 @@ public static int compareTo(Ref o1, String o2) {
* the reference instance. * the reference instance.
* @param o2 * @param o2
* the other reference instance. * the other reference instance.
* @return standard Comparator result of < 0, 0, > 0. * @return standard Comparator result of &lt; 0, 0, &gt; 0.
*/ */
public static int compareTo(final Ref o1, final Ref o2) { public static int compareTo(final Ref o1, final Ref o2) {
return o1.getName().compareTo(o2.getName()); return o1.getName().compareTo(o2.getName());

View File

@ -81,7 +81,7 @@ public class Tree extends TreeEntry {
* @param lasta '/' if a is a tree, else NUL * @param lasta '/' if a is a tree, else NUL
* @param lastb '/' if b is a tree, else NUL * @param lastb '/' if b is a tree, else NUL
* *
* @return < 0 if a is sorted before b, 0 if they are the same, else b * @return &lt; 0 if a is sorted before b, 0 if they are the same, else b
*/ */
public static final int compareNames(final byte[] a, final byte[] b, final int lasta,final int lastb) { public static final int compareNames(final byte[] a, final byte[] b, final int lasta,final int lastb) {
return compareNames(a, b, 0, b.length, lasta, lastb); return compareNames(a, b, 0, b.length, lasta, lastb);

View File

@ -111,7 +111,7 @@ public TreeFormatter(int size) {
} }
/** /**
* Add a link to a submodule commit, mode is {@link #GITLINK}. * Add a link to a submodule commit, mode is {@link FileMode#GITLINK}.
* *
* @param name * @param name
* name of the entry. * name of the entry.
@ -123,7 +123,7 @@ public void append(String name, RevCommit commit) {
} }
/** /**
* Add a subtree, mode is {@link #TREE}. * Add a subtree, mode is {@link FileMode#TREE}.
* *
* @param name * @param name
* name of the entry. * name of the entry.
@ -135,7 +135,7 @@ public void append(String name, RevTree tree) {
} }
/** /**
* Add a regular file, mode is {@link #REGULAR_FILE}. * Add a regular file, mode is {@link FileMode#REGULAR_FILE}.
* *
* @param name * @param name
* name of the entry. * name of the entry.

View File

@ -68,7 +68,7 @@ public class MergeFormatter {
* the merge result which should be presented * the merge result which should be presented
* @param seqName * @param seqName
* When a conflict is reported each conflicting range will get a * When a conflict is reported each conflicting range will get a
* name. This name is following the "<<<<<<< " or ">>>>>>> " * name. This name is following the "&lt;&lt;&lt;&lt;&lt;&lt;&lt; " or "&gt;&gt;&gt;&gt;&gt;&gt;&gt; "
* conflict markers. The names for the sequences are given in * conflict markers. The names for the sequences are given in
* this list * this list
* @param charsetName * @param charsetName

View File

@ -124,7 +124,7 @@ public String getValue() {
* Extract the email address (if present) from the footer. * Extract the email address (if present) from the footer.
* <p> * <p>
* If there is an email address looking string inside of angle brackets * If there is an email address looking string inside of angle brackets
* (e.g. "<a@b>"), the return value is the part extracted from inside the * (e.g. "&lt;a@b&gt;"), the return value is the part extracted from inside the
* brackets. If no brackets are found, then {@link #getValue()} is returned * brackets. If no brackets are found, then {@link #getValue()} is returned
* if the value contains an '@' sign. Otherwise, null. * if the value contains an '@' sign. Otherwise, null.
* *

View File

@ -344,7 +344,8 @@ public void fillTo(final int highMark) throws MissingObjectException,
* walker specified by {@link #source(RevWalk)} is pumped until the * walker specified by {@link #source(RevWalk)} is pumped until the
* specified commit is loaded. Callers can test the final size of the list * specified commit is loaded. Callers can test the final size of the list
* by {@link #size()} to determine if the high water mark specified was met. * by {@link #size()} to determine if the high water mark specified was met.
* <p/> * <p>
*
* @param commitToLoad * @param commitToLoad
* commit the caller wants this list to contain when the fill * commit the caller wants this list to contain when the fill
* operation is complete. * operation is complete.

View File

@ -599,7 +599,7 @@ public int getThreads() {
* Default setting: 0 (auto-detect processors) * Default setting: 0 (auto-detect processors)
* *
* @param threads * @param threads
* number of threads to use. If <= 0 the number of available * number of threads to use. If &lt;= 0 the number of available
* processors for this JVM is used. * processors for this JVM is used.
*/ */
public void setThreads(int threads) { public void setThreads(int threads) {

View File

@ -65,8 +65,8 @@
/** /**
* This URI like construct used for referencing Git archives over the net, as * This URI like construct used for referencing Git archives over the net, as
* well as locally stored archives. It is similar to RFC 2396 URI's, but also * well as locally stored archives. It is similar to RFC 2396 URI's, but also
* support SCP and the malformed file://<path> syntax (as opposed to the correct * support SCP and the malformed file://&lt;path&gt; syntax (as opposed to the correct
* file:<path> syntax. * file:&lt;path&gt; syntax.
*/ */
public class URIish implements Serializable { public class URIish implements Serializable {
/** /**
@ -660,7 +660,7 @@ public String toPrivateASCIIString() {
/** /**
* Get the "humanish" part of the path. Some examples of a 'humanish' part * Get the "humanish" part of the path. Some examples of a 'humanish' part
* for a full path: * for a full path:
* <table> * <table summary="path vs humanish path" border="1">
* <tr> * <tr>
* <th>Path</th> * <th>Path</th>
* <th>Humanish part</th> * <th>Humanish part</th>

View File

@ -110,7 +110,7 @@ private CanonicalTreeParser(final CanonicalTreeParser p) {
/** /**
* @return the parent of this tree parser * @return the parent of this tree parser
* @internal * @deprecated internal use only
*/ */
public CanonicalTreeParser getParent() { public CanonicalTreeParser getParent() {
return (CanonicalTreeParser) parent; return (CanonicalTreeParser) parent;

View File

@ -777,7 +777,7 @@ public int getPathLength() {
* end with '/' prior to invocation. * end with '/' prior to invocation.
* @param pLen * @param pLen
* number of bytes from <code>buf</code> to test. * number of bytes from <code>buf</code> to test.
* @return < 0 if p is before the current path; 0 if p matches the current * @return &lt; 0 if p is before the current path; 0 if p matches the current
* path; 1 if the current path is past p and p will never match * path; 1 if the current path is past p and p will never match
* again on this tree walk. * again on this tree walk.
*/ */

View File

@ -193,7 +193,7 @@ public static void delete(final File f, int options) throws IOException {
* the method fails. Furthermore if the destination exists and is a file * the method fails. Furthermore if the destination exists and is a file
* then the file will be deleted and then the rename is retried. * then the file will be deleted and then the rename is retried.
* <p> * <p>
* This operation is <em>not</me> atomic. * This operation is <em>not</em> atomic.
* *
* @see FS#retryFailedLockFileCommit() * @see FS#retryFailedLockFileCommit()
* @param src * @param src

View File

@ -317,7 +317,7 @@ public static int readFully(InputStream fd, byte[] dst, int off)
* @param fd * @param fd
* the stream to skip bytes from. * the stream to skip bytes from.
* @param toSkip * @param toSkip
* total number of bytes to be discarded. Must be >= 0. * total number of bytes to be discarded. Must be &gt;= 0.
* @throws EOFException * @throws EOFException
* the stream ended before the requested number of bytes were * the stream ended before the requested number of bytes were
* skipped. * skipped.

View File

@ -44,7 +44,7 @@
package org.eclipse.jgit.util; package org.eclipse.jgit.util;
/** A more efficient List<Integer> using a primitive integer array. */ /** A more efficient List&lt;Integer&gt; using a primitive integer array. */
public class IntList { public class IntList {
private int[] entries; private int[] entries;

View File

@ -46,7 +46,7 @@
import java.util.Arrays; import java.util.Arrays;
/** A more efficient List<Long> using a primitive long array. */ /** A more efficient List&lt;Long&gt; using a primitive long array. */
public class LongList { public class LongList {
private long[] entries; private long[] entries;

View File

@ -56,7 +56,7 @@ public final class NB {
* the first value to compare. * the first value to compare.
* @param b * @param b
* the second value to compare. * the second value to compare.
* @return < 0 if a < b; 0 if a == b; > 0 if a > b. * @return &lt; 0 if a &lt; b; 0 if a == b; &gt; 0 if a &gt; b.
*/ */
public static int compareUInt32(final int a, final int b) { public static int compareUInt32(final int a, final int b) {
final int cmp = (a >>> 1) - (b >>> 1); final int cmp = (a >>> 1) - (b >>> 1);

View File

@ -982,7 +982,7 @@ public static String decodeNoFallback(final Charset cs,
* Decode a region of the buffer under the ISO-8859-1 encoding. * Decode a region of the buffer under the ISO-8859-1 encoding.
* *
* Each byte is treated as a single character in the 8859-1 character * Each byte is treated as a single character in the 8859-1 character
* encoding, performing a raw binary->char conversion. * encoding, performing a raw binary-&gt;char conversion.
* *
* @param buffer * @param buffer
* buffer to pull raw bytes from. * buffer to pull raw bytes from.

View File

@ -113,7 +113,7 @@ public InterruptTimer(final String threadName) {
* *
* @param timeout * @param timeout
* number of milliseconds before the interrupt should trigger. * number of milliseconds before the interrupt should trigger.
* Must be > 0. * Must be &gt; 0.
*/ */
public void begin(final int timeout) { public void begin(final int timeout) {
if (timeout <= 0) if (timeout <= 0)

View File

@ -79,7 +79,7 @@ public int getTimeout() {
/** /**
* @param millis * @param millis
* number of milliseconds before aborting a read. Must be > 0. * number of milliseconds before aborting a read. Must be &gt; 0.
*/ */
public void setTimeout(final int millis) { public void setTimeout(final int millis) {
if (millis < 0) if (millis < 0)

View File

@ -80,7 +80,7 @@ public int getTimeout() {
/** /**
* @param millis * @param millis
* number of milliseconds before aborting a write. Must be > 0. * number of milliseconds before aborting a write. Must be &gt; 0.
*/ */
public void setTimeout(final int millis) { public void setTimeout(final int millis) {
if (millis < 0) if (millis < 0)