Skip to content

Commit

Permalink
Javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
augustd committed Dec 15, 2021
1 parent 4b8ca9b commit 154fb0b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public static String replaceCRLFWithUnderscore(String value) {
* @param value
* string to convert
* @return converted string
* @see https://unicode.org/versions/Unicode14.0.0/UnicodeStandard-14.0.pdf#page=235
* @see <a href="https://unicode.org/versions/Unicode14.0.0/UnicodeStandard-14.0.pdf#page=235">Unicode Standard</a>
*/
public static String escapeNLFChars(String value) {
return value.replace("\n", "\\n")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ public static void bindSystemStreamsToSLF4J() {
/**
* Redirect <code>System.out</code> and <code>System.err</code> streams to the given SLF4J loggers.
* This is a benefit if you have a legacy console logger application. Does not provide
* benefit of a full implementation. For example, no hierarchical or logger inheritence
* support but there are some ancilarity benefits like, 1) capturing messages that would
* benefit of a full implementation. For example, no hierarchical or logger inheritance
* support but there are some ancillary benefits like, 1) capturing messages that would
* otherwise be lost, 2) redirecting console messages to centralized log services, 3)
* formatting console messages in other types of output (e.g., HTML).
*
* @param sysOutLogger
* @param sysErrLogger
* @param newSysOutLogger Logger to use for System.out
* @param newSysErrLogger Logger to use for System.err
*/
public static void bindSystemStreamsToSLF4J(Logger newSysOutLogger, Logger newSysErrLogger) {
if (newSysOutLogger != null) SecurityUtil.sysOutLogger = newSysOutLogger;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Throwable proxy that replaces CR/LF chars in the message to avoid log injection
* in exception messages.
* Calls to getMessage are intercepted to replace CR & LF in the message
* Calls to getMessage are intercepted to replace CR and LF in the message
* Calls to getCause are intercepted to ensure all exceptions in the stack are treated
* All other other methods are directly sent through the proxied instance.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@
* Masks social security numbers in log messages. SSNs consist of digits separated
* by dashes in the form <b>###-##-####</b>.
*
* The following famous/test SSNs are not masked:
* The following famous/test SSNs are not masked:
* <ul>
* <li>219-09-9999 (Social Security Board pamphlet)
* <li>078-05-1120 (Woolworth wallets: Mrs. Hilda Schrader Whitcher)
* <li>matches starting with 000 or 666
* <li>matches containing 00 as the middle two digits
* <li>matches containing 0000 as the final four digits
*
* </ul>
*
* @author augustd
*/
public class SSNMaskingConverter extends ClassicConverter {
Expand Down

0 comments on commit 154fb0b

Please sign in to comment.