Javadoc warning fixes (#109)

jamesjer · wumpz · web-flow · commit c85296b63de0 · 2021-09-08T12:21:50.000+02:00
Co-authored-by: Tobias &lt;t.warneke@gmx.net&gt;
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
@@ -129,15 +129,14 @@ private static void processLinesInPrevChunk(List<String[]> rawChunk, Patch<Strin
 
     /**
      * generateUnifiedDiff takes a Patch and some other arguments, returning the Unified Diff format
-     * text representing the Patch.
+     * text representing the Patch.  Author: Bill James (tankerbay@gmail.com).
      *
      * @param originalFileName - Filename of the original (unrevised file)
      * @param revisedFileName - Filename of the revised file
      * @param originalLines - Lines of the original file
      * @param patch - Patch created by the diff() function
      * @param contextSize - number of lines of context output around each difference in the file.
      * @return List of strings representing the Unified Diff representation of the Patch argument.
-     * @author Bill James (tankerbay@gmail.com)
      */
     public static List<String> generateUnifiedDiff(String originalFileName,
             String revisedFileName, List<String> originalLines, Patch<String> patch,
@@ -200,13 +199,12 @@ public static List<String> 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<String> processDeltas(List<String> origLines,
             List<AbstractDelta<String>> deltas, int contextSize, boolean newFile) {
@@ -297,11 +295,10 @@ private static List<String> processDeltas(List<String> 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<String> getDeltaText(AbstractDelta<String> delta) {
         List<String> 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
@@ -554,8 +554,8 @@ public Builder processDiffs(Function<String, String> 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. @return builder with config of column width
+         * @param width the width to set. Making it &lt; 0 doesn't make any sense. Default 80.
+         * @return builder with config of column width
          */
         public Builder columnWidth(int width) {
             if (width >= 0) {
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
@@ -189,10 +189,10 @@ private static void processDeltas(Consumer<String> 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. 
      *
-     * @param delta - the Delta to output
-     * @return list of String lines of code.
+     * @param writer consumer for the list of String lines of code
+     * @param delta the Delta to output
      */
     private static void getDeltaText(Consumer<String> writer, AbstractDelta<String> delta) {
         for (String line : delta.getSource().getLines()) {

Original file line number	Diff line number	Diff line change
`@@ -189,10 +189,10 @@ private static void processDeltas(Consumer<String> writer,`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`/**`
`192`		`- * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter`
	`192`	`+ * getDeltaText returns the lines to be added to the Unified Diff text from the Delta parameter.`
`193`	`193`	`*`
`194`		`- * @param delta - the Delta to output`
`195`		`- * @return list of String lines of code.`
	`194`	`+ * @param writer consumer for the list of String lines of code`
	`195`	`+ * @param delta the Delta to output`
`196`	`196`	`*/`
`197`	`197`	`private static void getDeltaText(Consumer<String> writer, AbstractDelta<String> delta) {`
`198`	`198`	`for (String line : delta.getSource().getLines()) {`