Fix Javadoc warnings

There were some broken links, incorrect uses of @value, an invalid
tag and an outdated comment.

Change-Id: I22886bcc869a4b62bd606ebed40669f7b4723664
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/MyersDiffPerformanceTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/MyersDiffPerformanceTest.java
index fe63e3d183b27a3289f87d38f840f580b1f92a87..37a9a4d6369820b8fb5e318bda95512ad7e0c60a 100644 (file)
--- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/MyersDiffPerformanceTest.java
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/diff/MyersDiffPerformanceTest.java
@@ -60,7 +60,7 @@ import org.eclipse.jgit.util.CPUTimeStopWatch;
  * time for computing the diff between a and b should depend on the product of
  * a.length+b.length and the number of found differences. The tests compute
  * diffs between chunks of different length, measure the needed time and check
- * that time/(N*D) does not differ more than a certain factor (currently 10)
+ * that time/(N*D) does not differ more than a certain factor.
  */
 public class MyersDiffPerformanceTest extends TestCase {
        private static final long longTaskBoundary = 5000000000L;

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ConcurrentRefUpdateException.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ConcurrentRefUpdateException.java
index 6f681b68cc52c9a763e1db7ea16154d73ebe1256..2a5f7f922586e2e9e4689c6a9b97f65716ed4173 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/ConcurrentRefUpdateException.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ConcurrentRefUpdateException.java
@@ -47,7 +47,7 @@ import org.eclipse.jgit.lib.RefUpdate;
  * Exception thrown when a command wants to update a ref but failed because
  * another process is accessing (or even also updating) the ref.
  *
- * @see RefUpdate.Result#LOCK_FAILURE
+ * @see org.eclipse.jgit.lib.RefUpdate.Result#LOCK_FAILURE
  */
 public class ConcurrentRefUpdateException extends GitAPIException {
        private static final long serialVersionUID = 1L;

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java
index 414fac4f3870f3e911bfa5e111b861422fdf7dd0..61a87b416a98ab97c2f252ecaf737933f472236c 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java
@@ -64,7 +64,7 @@ import org.eclipse.jgit.revwalk.RevWalk;
  * This is currently a very basic implementation which takes only one starting
  * revision as option.
  *
- * @TODO add more options (revision ranges, sorting, ...)
+ * TODO: add more options (revision ranges, sorting, ...)
  *
  * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-log.html"
  *      >Git documentation about Log</a>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeChunk.java b/org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeChunk.java
index 1127b89a90d437ab5c9b06c3380d27908fb88f9c..72857ffb301fe32eb3f7bb7da46453ab41fe6e88 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeChunk.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/merge/MergeChunk.java
@@ -87,7 +87,7 @@ public class MergeChunk {
         *
         * @param sequenceIndex
         *            determines to which sequence this chunks belongs to. Same as
-        *            in {@link MergeResult#add(int, int, int, ConflictState)}
+        *            in {@link org.eclipse.jgit.merge.MergeResult#add}
         * @param begin
         *            the first element from the specified sequence which should be
         *            included in the merge result. Indexes start with 0.
@@ -109,8 +109,7 @@ public class MergeChunk {
 
        /**
         * @return the index of the sequence to which sequence this chunks belongs
-        *         to. Same as in
-        *         {@link MergeResult#add(int, int, int, ConflictState)}
+        *         to. Same as in {@link org.eclipse.jgit.merge.MergeResult#add}
         */
        public int getSequenceIndex() {
                return sequenceIndex;

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackWriter.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackWriter.java
index 38f00b5739f58d325133a62e3cf0025f06d03e72..de8a9fcea6fc98cf33780af0e7eef8542f2645df 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackWriter.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/pack/PackWriter.java
@@ -311,7 +311,7 @@ public class PackWriter {
         * Check whether object is configured to reuse deltas existing in
         * repository.
         * <p>
-        * Default setting: {@value #DEFAULT_REUSE_DELTAS}
+        * Default setting: {@link #DEFAULT_REUSE_DELTAS}
         * </p>
         *
         * @return true if object is configured to reuse deltas; false otherwise.
@@ -334,7 +334,7 @@ public class PackWriter {
         * computed to verify data.
         * </p>
         * <p>
-        * Default setting: {@value #DEFAULT_REUSE_DELTAS}
+        * Default setting: {@link #DEFAULT_REUSE_DELTAS}
         * </p>
         *
         * @param reuseDeltas
@@ -348,7 +348,7 @@ public class PackWriter {
         * Checks whether object is configured to reuse existing objects
         * representation in repository.
         * <p>
-        * Default setting: {@value #DEFAULT_REUSE_OBJECTS}
+        * Default setting: {@link #DEFAULT_REUSE_OBJECTS}
         * </p>
         *
         * @return true if writer is configured to reuse objects representation from
@@ -364,7 +364,7 @@ public class PackWriter {
         * compressed data is directly copied from such a pack file. Data checksum
         * is verified.
         * <p>
-        * Default setting: {@value #DEFAULT_REUSE_OBJECTS}
+        * Default setting: {@link #DEFAULT_REUSE_OBJECTS}
         * </p>
         *
         * @param reuseObjects
@@ -380,7 +380,7 @@ public class PackWriter {
         * reducing pack size) or should store it as an object id (legacy style,
         * compatible with old readers).
         * <p>
-        * Default setting: {@value #DEFAULT_DELTA_BASE_AS_OFFSET}
+        * Default setting: {@link #DEFAULT_DELTA_BASE_AS_OFFSET}
         * </p>
         *
         * @return true if delta base is stored as an offset; false if it is stored
@@ -395,7 +395,7 @@ public class PackWriter {
         * pack file (new approach reducing file size) or as an object id (legacy
         * approach, compatible with old readers).
         * <p>
-        * Default setting: {@value #DEFAULT_DELTA_BASE_AS_OFFSET}
+        * Default setting: {@link #DEFAULT_DELTA_BASE_AS_OFFSET}
         * </p>
         *
         * @param deltaBaseAsOffset
@@ -436,7 +436,7 @@ public class PackWriter {
         * Get maximum depth of delta chain set up for this writer. Generated chains
         * are not longer than this value.
         * <p>
-        * Default setting: {@value #DEFAULT_MAX_DELTA_DEPTH}
+        * Default setting: {@link #DEFAULT_MAX_DELTA_DEPTH}
         * </p>
         *
         * @return maximum delta chain depth.
@@ -450,7 +450,7 @@ public class PackWriter {
         * not longer than this value. Too low value causes low compression level,
         * while too big makes unpacking (reading) longer.
         * <p>
-        * Default setting: {@value #DEFAULT_MAX_DELTA_DEPTH}
+        * Default setting: {@link #DEFAULT_MAX_DELTA_DEPTH}
         * </p>
         *
         * @param maxDeltaDepth
@@ -475,7 +475,7 @@ public class PackWriter {
        /**
         * Set the number of objects considered when searching for a delta base.
         * <p>
-        * Default setting: {@value #DEFAULT_DELTA_SEARCH_WINDOW_SIZE}
+        * Default setting: {@link #DEFAULT_DELTA_SEARCH_WINDOW_SIZE}
         * </p>
         *
         * @param objectCount
@@ -838,9 +838,9 @@ public class PackWriter {
         * <p>
         * At first, this method collects and sorts objects to pack, then deltas
         * search is performed if set up accordingly, finally pack stream is
-        * written. {@link ProgressMonitor} tasks {@value #COMPRESSING_OBJECTS_PROGRESS}
+        * written. {@link ProgressMonitor} tasks {@link #COMPRESSING_OBJECTS_PROGRESS}
         * (only if reuseDeltas or reuseObjects is enabled) and
-        * {@value #WRITING_OBJECTS_PROGRESS} are updated during packing.
+        * {@link #WRITING_OBJECTS_PROGRESS} are updated during packing.
         * </p>
         * <p>
         * All reused objects data checksum (Adler32/CRC32) is computed and