Skip to content

Javadoc warning fixes #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2021
Merged

Javadoc warning fixes #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abbedf9
Javadoc warning fixes
jamesjer Dec 15, 2020
93bdd90
Merge branch 'master' into javadoc
wumpz Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions java-diff-utils/src/main/java/com/github/difflib/UnifiedDiffUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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<>();
Expand Down
4 changes: 2 additions & 2 deletions java-diff-utils/src/main/java/com/github/difflib/text/DiffRowGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
6 changes: 3 additions & 3 deletions java-diff-utils/src/main/java/com/github/difflib/unifieddiff/UnifiedDiffWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down