Skip to content

Commit e8c015a

Browse files
committed
Fix Javadoc errors
Signed-off-by: Stephen Kitt <skitt@redhat.com>
1 parent 765dc29 commit e8c015a

File tree

10 files changed

+13
-19
lines changed

10 files changed

+13
-19
lines changed

src/main/java/com/github/difflib/algorithm/DifferentiationFailedException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
/**
1919
* Thrown whenever the differencing engine cannot produce the differences between two revisions of ta text.
2020
*
21-
* @see MyersDiff
22-
* @see difflib.DiffAlgorithm
21+
* @see com.github.difflib.algorithm.myers.MyersDiff
22+
* @see DiffAlgorithmI
2323
*/
2424
public class DifferentiationFailedException extends DiffException {
2525

src/main/java/com/github/difflib/algorithm/myers/MyersDiff.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ private PathNode buildPath(final List<T> orig, final List<T> rev, DiffAlgorithmL
138138
/**
139139
* Constructs a {@link Patch} from a difference path.
140140
*
141-
* @param path The path.
141+
* @param actualPath The path.
142142
* @param orig The original sequence.
143143
* @param rev The revised sequence.
144144
* @return A {@link Patch} script corresponding to the path.

src/main/java/com/github/difflib/algorithm/myers/PathNode.java

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@
1919
* A node in a diffpath.
2020
*
2121
* @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
22-
*
23-
* @see DiffNode
24-
* @see Snake
25-
*
2622
*/
2723
public final class PathNode {
2824

@@ -78,10 +74,10 @@ public boolean isBootstrap() {
7874
}
7975

8076
/**
81-
* Skips sequences of {@link DiffNode DiffNodes} until a {@link Snake} or bootstrap node is found, or the end of the
77+
* Skips sequences of {@link PathNode PathNodes} until a snake or bootstrap node is found, or the end of the
8278
* path is reached.
8379
*
84-
* @return The next first {@link Snake} or bootstrap node in the path, or <code>null</code> if none found.
80+
* @return The next first {@link PathNode} or bootstrap node in the path, or <code>null</code> if none found.
8581
*/
8682
public final PathNode previousSnake() {
8783
if (isBootstrap()) {

src/main/java/com/github/difflib/patch/ChangeDelta.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* Describes the change-delta between original and revised texts.
2323
*
2424
* @author <a href="dm.naumenko@gmail.com">Dmitry Naumenko</a>
25-
* @param T The type of the compared elements in the data 'lines'.
25+
* @param <T> The type of the compared elements in the data 'lines'.
2626
*/
2727
public final class ChangeDelta<T> extends AbstractDelta<T> {
2828

src/main/java/com/github/difflib/patch/Chunk.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* </p>
3030
*
3131
* @author <a href="dm.naumenko@gmail.com>Dmitry Naumenko</a>
32-
* @param T The type of the compared elements in the 'lines'.
32+
* @param <T> The type of the compared elements in the 'lines'.
3333
*/
3434
public final class Chunk<T> {
3535

src/main/java/com/github/difflib/patch/DeleteDelta.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Describes the delete-delta between original and revised texts.
2222
*
2323
* @author <a href="dm.naumenko@gmail.com">Dmitry Naumenko</a>
24-
* @param T The type of the compared elements in the 'lines'.
24+
* @param <T> The type of the compared elements in the 'lines'.
2525
*/
2626
public final class DeleteDelta<T> extends AbstractDelta<T> {
2727

src/main/java/com/github/difflib/patch/InsertDelta.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Describes the add-delta between original and revised texts.
2222
*
2323
* @author <a href="dm.naumenko@gmail.com">Dmitry Naumenko</a>
24-
* @param T The type of the compared elements in the 'lines'.
24+
* @param <T> The type of the compared elements in the 'lines'.
2525
*/
2626
public final class InsertDelta<T> extends AbstractDelta<T> {
2727

src/main/java/com/github/difflib/patch/Patch.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* Describes the patch holding all deltas between the original and revised texts.
3030
*
3131
* @author <a href="dm.naumenko@gmail.com">Dmitry Naumenko</a>
32-
* @param T The type of the compared elements in the 'lines'.
32+
* @param <T> The type of the compared elements in the 'lines'.
3333
*/
3434
public final class Patch<T> {
3535

src/main/java/com/github/difflib/text/DiffRowGenerator.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,7 @@ protected final static List<String> splitStringPreserveDelimiter(String str, Pat
9898
*
9999
* @param startPosition the position from which tag should start. The counting start from a zero.
100100
* @param endPosition the position before which tag should should be closed.
101-
* @param tag the tag name without angle brackets, just a word
102-
* @param cssClass the optional css class
101+
* @param tagGenerator the tag generator
103102
*/
104103
static void wrapInTag(List<String> sequence, int startPosition,
105104
int endPosition, Function<Boolean, String> tagGenerator) {
@@ -179,7 +178,6 @@ public List<DiffRow> generateDiffRows(List<String> original, List<String> revise
179178
* for displaying side-by-side diff.
180179
*
181180
* @param original the original text
182-
* @param revised the revised text
183181
* @param patch the given patch
184182
* @return the DiffRows between original and revised texts
185183
*/
@@ -400,7 +398,7 @@ public Builder reportLinesUnchanged(final boolean val) {
400398
/**
401399
* Generator for Old-Text-Tags.
402400
*
403-
* @param tag the tag to set. Without angle brackets. Default: span.
401+
* @param generator the tag generator
404402
* @return builder with configured ignoreBlankLines parameter
405403
*/
406404
public Builder oldTag(Function<Boolean, String> generator) {

src/test/java/com/github/difflib/TestConstants.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public final class TestConstants {
1010

1111
public static final String BASE_FOLDER_RESOURCES = "target/test-classes/";
1212
/**
13-
* The base folder containing the test files. Ends with {@link #FS}.
13+
* The base folder containing the test files.
1414
*/
1515
public static final String MOCK_FOLDER = BASE_FOLDER_RESOURCES + "/mocks/";
1616

0 commit comments

Comments
 (0)