From e8c015a2ec6ec724c417e1125b85b162473a8c7e Mon Sep 17 00:00:00 2001 From: Stephen Kitt Date: Fri, 8 Feb 2019 09:17:43 +0100 Subject: [PATCH] Fix Javadoc errors Signed-off-by: Stephen Kitt --- .../difflib/algorithm/DifferentiationFailedException.java | 4 ++-- .../com/github/difflib/algorithm/myers/MyersDiff.java | 2 +- .../java/com/github/difflib/algorithm/myers/PathNode.java | 8 ++------ src/main/java/com/github/difflib/patch/ChangeDelta.java | 2 +- src/main/java/com/github/difflib/patch/Chunk.java | 2 +- src/main/java/com/github/difflib/patch/DeleteDelta.java | 2 +- src/main/java/com/github/difflib/patch/InsertDelta.java | 2 +- src/main/java/com/github/difflib/patch/Patch.java | 2 +- .../java/com/github/difflib/text/DiffRowGenerator.java | 6 ++---- src/test/java/com/github/difflib/TestConstants.java | 2 +- 10 files changed, 13 insertions(+), 19 deletions(-) diff --git a/src/main/java/com/github/difflib/algorithm/DifferentiationFailedException.java b/src/main/java/com/github/difflib/algorithm/DifferentiationFailedException.java index 682a9b4..e201e44 100644 --- a/src/main/java/com/github/difflib/algorithm/DifferentiationFailedException.java +++ b/src/main/java/com/github/difflib/algorithm/DifferentiationFailedException.java @@ -18,8 +18,8 @@ package com.github.difflib.algorithm; /** * Thrown whenever the differencing engine cannot produce the differences between two revisions of ta text. * - * @see MyersDiff - * @see difflib.DiffAlgorithm + * @see com.github.difflib.algorithm.myers.MyersDiff + * @see DiffAlgorithmI */ public class DifferentiationFailedException extends DiffException { diff --git a/src/main/java/com/github/difflib/algorithm/myers/MyersDiff.java b/src/main/java/com/github/difflib/algorithm/myers/MyersDiff.java index 8c18341..abcf31e 100644 --- a/src/main/java/com/github/difflib/algorithm/myers/MyersDiff.java +++ b/src/main/java/com/github/difflib/algorithm/myers/MyersDiff.java @@ -138,7 +138,7 @@ public final class MyersDiff implements DiffAlgorithmI { /** * Constructs a {@link Patch} from a difference path. * - * @param path The path. + * @param actualPath The path. * @param orig The original sequence. * @param rev The revised sequence. * @return A {@link Patch} script corresponding to the path. diff --git a/src/main/java/com/github/difflib/algorithm/myers/PathNode.java b/src/main/java/com/github/difflib/algorithm/myers/PathNode.java index f3c153f..fe8fd03 100644 --- a/src/main/java/com/github/difflib/algorithm/myers/PathNode.java +++ b/src/main/java/com/github/difflib/algorithm/myers/PathNode.java @@ -19,10 +19,6 @@ package com.github.difflib.algorithm.myers; * A node in a diffpath. * * @author Juanco Anez - * - * @see DiffNode - * @see Snake - * */ public final class PathNode { @@ -78,10 +74,10 @@ public final class PathNode { } /** - * Skips sequences of {@link DiffNode DiffNodes} until a {@link Snake} or bootstrap node is found, or the end of the + * Skips sequences of {@link PathNode PathNodes} until a snake or bootstrap node is found, or the end of the * path is reached. * - * @return The next first {@link Snake} or bootstrap node in the path, or null if none found. + * @return The next first {@link PathNode} or bootstrap node in the path, or null if none found. */ public final PathNode previousSnake() { if (isBootstrap()) { diff --git a/src/main/java/com/github/difflib/patch/ChangeDelta.java b/src/main/java/com/github/difflib/patch/ChangeDelta.java index 43f68b3..7c1cd98 100644 --- a/src/main/java/com/github/difflib/patch/ChangeDelta.java +++ b/src/main/java/com/github/difflib/patch/ChangeDelta.java @@ -22,7 +22,7 @@ import java.util.Objects; * Describes the change-delta between original and revised texts. * * @author Dmitry Naumenko - * @param T The type of the compared elements in the data 'lines'. + * @param The type of the compared elements in the data 'lines'. */ public final class ChangeDelta extends AbstractDelta { diff --git a/src/main/java/com/github/difflib/patch/Chunk.java b/src/main/java/com/github/difflib/patch/Chunk.java index ed70e20..6c1a991 100644 --- a/src/main/java/com/github/difflib/patch/Chunk.java +++ b/src/main/java/com/github/difflib/patch/Chunk.java @@ -29,7 +29,7 @@ import java.util.Objects; *

* * @author Dmitry Naumenko - * @param T The type of the compared elements in the 'lines'. + * @param The type of the compared elements in the 'lines'. */ public final class DeleteDelta extends AbstractDelta { diff --git a/src/main/java/com/github/difflib/patch/InsertDelta.java b/src/main/java/com/github/difflib/patch/InsertDelta.java index 08de5f1..12164fa 100644 --- a/src/main/java/com/github/difflib/patch/InsertDelta.java +++ b/src/main/java/com/github/difflib/patch/InsertDelta.java @@ -21,7 +21,7 @@ import java.util.List; * Describes the add-delta between original and revised texts. * * @author Dmitry Naumenko - * @param T The type of the compared elements in the 'lines'. + * @param The type of the compared elements in the 'lines'. */ public final class InsertDelta extends AbstractDelta { diff --git a/src/main/java/com/github/difflib/patch/Patch.java b/src/main/java/com/github/difflib/patch/Patch.java index 74e99f8..688e9f1 100644 --- a/src/main/java/com/github/difflib/patch/Patch.java +++ b/src/main/java/com/github/difflib/patch/Patch.java @@ -29,7 +29,7 @@ import java.util.ListIterator; * Describes the patch holding all deltas between the original and revised texts. * * @author Dmitry Naumenko - * @param T The type of the compared elements in the 'lines'. + * @param The type of the compared elements in the 'lines'. */ public final class Patch { diff --git a/src/main/java/com/github/difflib/text/DiffRowGenerator.java b/src/main/java/com/github/difflib/text/DiffRowGenerator.java index 1f2d8e0..c026734 100644 --- a/src/main/java/com/github/difflib/text/DiffRowGenerator.java +++ b/src/main/java/com/github/difflib/text/DiffRowGenerator.java @@ -98,8 +98,7 @@ public class DiffRowGenerator { * * @param startPosition the position from which tag should start. The counting start from a zero. * @param endPosition the position before which tag should should be closed. - * @param tag the tag name without angle brackets, just a word - * @param cssClass the optional css class + * @param tagGenerator the tag generator */ static void wrapInTag(List sequence, int startPosition, int endPosition, Function tagGenerator) { @@ -179,7 +178,6 @@ public class DiffRowGenerator { * for displaying side-by-side diff. * * @param original the original text - * @param revised the revised text * @param patch the given patch * @return the DiffRows between original and revised texts */ @@ -400,7 +398,7 @@ public class DiffRowGenerator { /** * Generator for Old-Text-Tags. * - * @param tag the tag to set. Without angle brackets. Default: span. + * @param generator the tag generator * @return builder with configured ignoreBlankLines parameter */ public Builder oldTag(Function generator) { diff --git a/src/test/java/com/github/difflib/TestConstants.java b/src/test/java/com/github/difflib/TestConstants.java index 56f5bf6..ba6d754 100644 --- a/src/test/java/com/github/difflib/TestConstants.java +++ b/src/test/java/com/github/difflib/TestConstants.java @@ -10,7 +10,7 @@ public final class TestConstants { public static final String BASE_FOLDER_RESOURCES = "target/test-classes/"; /** - * The base folder containing the test files. Ends with {@link #FS}. + * The base folder containing the test files. */ public static final String MOCK_FOLDER = BASE_FOLDER_RESOURCES + "/mocks/";