X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FWarningMessage.java;h=ae6cdbd103698e8255df8b6c7ada498b150f91f0;hb=eab9331afd014558a982441138e222999a9955d1;hp=d4a6da4dd1df4231960346ec8ae87ddaa224bbfb;hpb=397201c278ded558e45d406967f153770784ff88;p=ldk-java diff --git a/src/main/java/org/ldk/structs/WarningMessage.java b/src/main/java/org/ldk/structs/WarningMessage.java index d4a6da4d..ae6cdbd1 100644 --- a/src/main/java/org/ldk/structs/WarningMessage.java +++ b/src/main/java/org/ldk/structs/WarningMessage.java @@ -9,7 +9,9 @@ import javax.annotation.Nullable; /** - * A warning message to be sent or received from a peer + * A [`warning`] message to be sent to or received from a peer. + * + * [`warning`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages */ @SuppressWarnings("unchecked") // We correctly assign various generic arrays public class WarningMessage extends CommonBase { @@ -44,6 +46,7 @@ public class WarningMessage extends CommonBase { /** * A possibly human-readable warning description. + * * The string should be sanitized before it is used (e.g. emitted to logs or printed to * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in * the terminal emulator or the logging subsystem. @@ -56,6 +59,7 @@ public class WarningMessage extends CommonBase { /** * A possibly human-readable warning description. + * * The string should be sanitized before it is used (e.g. emitted to logs or printed to * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in * the terminal emulator or the logging subsystem.