Update documentation

PGMDev · Nov 6, 2024 · 51a6564 · 51a6564
1 parent a3c9e3f
commit 51a6564
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/core/src/main/java/tc/oc/pgm/api/channels/Channel.java b/core/src/main/java/tc/oc/pgm/api/channels/Channel.java
@@ -64,6 +64,13 @@ default SettingValue getSetting() {
     return null;
   }
 
+  /**
+   * Retrieves the format these channel messages should be logged using via the
+   * {@code AsyncPlayerChatEvent}.
+   *
+   * @param target the message target
+   * @return formatted messaged printed to console
+   */
   default String getLoggerFormat(T target) {
     return "<%s>: %s";
   }