From abbedf9d3b93625a4b4c50b650c7d8d0cf7f849d Mon Sep 17 00:00:00 2001 From: Jerry James Date: Tue, 15 Dec 2020 08:51:09 -0700 Subject: [PATCH] Javadoc warning fixes --- .../main/java/com/github/difflib/UnifiedDiffUtils.java | 9 +++------ .../java/com/github/difflib/text/DiffRowGenerator.java | 2 +- .../github/difflib/unifieddiff/UnifiedDiffWriter.java | 7 +++---- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/java-diff-utils/src/main/java/com/github/difflib/UnifiedDiffUtils.java b/java-diff-utils/src/main/java/com/github/difflib/UnifiedDiffUtils.java index 2098aacf..06a61073 100644 --- a/java-diff-utils/src/main/java/com/github/difflib/UnifiedDiffUtils.java +++ b/java-diff-utils/src/main/java/com/github/difflib/UnifiedDiffUtils.java @@ -129,7 +129,7 @@ private static void processLinesInPrevChunk(List rawChunk, Patch rawChunk, Patch generateUnifiedDiff(String originalFileName, String revisedFileName, List originalLines, Patch patch, @@ -200,13 +199,12 @@ public static List generateUnifiedDiff(String originalFileName, /** * processDeltas takes a list of Deltas and outputs them together in a single block of - * Unified-Diff-format text. + * Unified-Diff-format text. Author: Bill James (tankerbay@gmail.com). * * @param origLines - the lines of the original file * @param deltas - the Deltas to be output as a single block * @param contextSize - the number of lines of context to place around block * @return - * @author Bill James (tankerbay@gmail.com) */ private static List processDeltas(List origLines, List> deltas, int contextSize, boolean newFile) { @@ -297,11 +295,10 @@ private static List processDeltas(List origLines, } /** - * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter + * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter. Author: Bill James (tankerbay@gmail.com). * * @param delta - the Delta to output * @return list of String lines of code. - * @author Bill James (tankerbay@gmail.com) */ private static List getDeltaText(AbstractDelta delta) { List buffer = new ArrayList<>(); diff --git a/java-diff-utils/src/main/java/com/github/difflib/text/DiffRowGenerator.java b/java-diff-utils/src/main/java/com/github/difflib/text/DiffRowGenerator.java index c315c45c..9361fc5f 100644 --- a/java-diff-utils/src/main/java/com/github/difflib/text/DiffRowGenerator.java +++ b/java-diff-utils/src/main/java/com/github/difflib/text/DiffRowGenerator.java @@ -506,7 +506,7 @@ public Builder processDiffs(Function processDiffs) { /** * Set the column width of generated lines of original and revised texts. * - * @param width the width to set. Making it < 0 doesn't make any sense. Default 80. + * @param width the width to set. Making it < 0 doesn't make any sense. Default 80. * @return builder with config of column width */ public Builder columnWidth(int width) { diff --git a/java-diff-utils/src/main/java/com/github/difflib/unifieddiff/UnifiedDiffWriter.java b/java-diff-utils/src/main/java/com/github/difflib/unifieddiff/UnifiedDiffWriter.java index 320e6858..1461bcc2 100644 --- a/java-diff-utils/src/main/java/com/github/difflib/unifieddiff/UnifiedDiffWriter.java +++ b/java-diff-utils/src/main/java/com/github/difflib/unifieddiff/UnifiedDiffWriter.java @@ -189,11 +189,10 @@ private static void processDeltas(Consumer writer, } /** - * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter + * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter. Author: Bill James (tankerboy@gmail.com). * - * @param delta - the Delta to output - * @return list of String lines of code. - * @author Bill James (tankerbay@gmail.com) + * @param writer consumer for the list of String lines of code + * @param delta the Delta to output */ private static void getDeltaText(Consumer writer, AbstractDelta delta) { for (String line : delta.getSource().getLines()) {