Skip to content
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.

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

[MSHARED-954] fix JavaDoc typos #64

Merged
merged 3 commits into from
Aug 24, 2020
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions src/main/java/org/apache/maven/shared/utils/StringUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -2398,15 +2398,15 @@ public static String escape( @Nullable String source, @Nonnull final char[] esca

/**
* Parses the given String and replaces all occurrences of
* '\n', '\r' and '\r\n' with the system line separator.
* '\n', '\r', and "\r\n" with the system line separator.
*
* @param s a not null String
* @return a String that contains only System line separators
* @see #unifyLineSeparators(String, String)
* @deprecated this method produces platform dependent code and contributes to
* non-reproducible builds. In the context of Maven, this is almost never what's needed.
* Remove calls to this method and do not replace them. That is, change
* {@code Stringutils.unifyLineSeparators(s)} with simply {@code s}.
* {@code Stringutils.unifyLineSeparators(s)} to simply {@code s}.
*/
@Deprecated
public static String unifyLineSeparators( @Nullable String s )
Expand All @@ -2419,9 +2419,9 @@ public static String unifyLineSeparators( @Nullable String s )
* '\n', '\r' and '\r\n' with the system line separator.
*
* @param s a not null String
* @param ls the wanted line separator ("\n" on UNIX), if null using the System line separator.
* @param ls the wanted line separator ("\n" on UNIX), if null using the System line separator
* @return a String that contains only System line separators
* @throws IllegalArgumentException if ls is not '\n', '\r' and '\r\n' characters.
* @throws IllegalArgumentException if ls is not '\n', '\r', or "\r\n"
*
*/
public static String unifyLineSeparators( @Nullable String s, @Nullable String ls )
Expand Down