La till Docstrings efter feedback.

Author: Rickank

src/main/java/com/example/FxUtils.java

@@ -4,6 +4,13 @@
 
 public class FxUtils {
 
+    /**
+     * Runs a task on the JavaFX thread.
+     * If already on the thread, runs immediately.
+     * If not, schedules it to run later.
+     * If JavaFX is not initialized, runs on the current thread.
+     */
+
     public static void runOnFx(Runnable task) {
         try {
             if (Platform.isFxApplicationThread()) {

src/main/java/com/example/HelloController.java

@@ -13,7 +13,10 @@
 import java.time.format.DateTimeFormatter;
 
 /**
- * Controller layer: mediates between the view (FXML) and the model.
+ * Controller for the chat app.
+ * <p>
+ * Connects the FXML view to the HelloModel.
+ * Handles sending messages, changing topics, and updating the UI.
  */
 
 public class HelloController {

src/main/java/com/example/HelloFX.java

@@ -8,6 +8,12 @@
 
 import java.util.Objects;
 
+/**
+ * Main JavaFX application class for RuneChat.
+ * <p>
+ * Loads the FXML view, applies the stylesheet, and starts the application window.
+ */
+
 public class HelloFX extends Application {
 
     @Override

src/main/java/com/example/HelloModel.java

@@ -10,6 +10,12 @@
 
 import static com.example.FxUtils.runOnFx;
 
+/**
+ * Model layer for the chatapp RuneChat.
+ * <p>
+ * Manages messages, the current topic, and sending/receiving messages via NtfyConnection.
+ */
+
 public class HelloModel {
 
     private final NtfyConnection connection;

src/main/java/com/example/NtfyConnection.java

@@ -4,20 +4,30 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
 
+/**
+ * Interface for sending and receiving messages via a notification service.
+ */
 public interface NtfyConnection {
 
     void send(String message, Consumer<Boolean> callback);
 
+    /**
+     * Receives messages from the service.
+     * @param messageHandler called for each received message
+     */
     void receive(Consumer<NtfyMessageDto> messageHandler);
 
+    /** Returns the current topic. Default is "mytopic". */
     default String getCurrentTopic() {
         return "mytopic";
     }
 
+    /** Sets the current topic. Default does nothing. */
     default void setCurrentTopic(String topic) {
 
     }
 
+    /** Returns the user ID. Default is "unknown". */
     default String getUserId() {
         return "unknown";
     }

src/main/java/com/example/NtfyConnectionImpl.java

@@ -10,6 +10,9 @@
 import java.util.Objects;
 import java.util.function.Consumer;
 
+/**
+ * Implementation of NtfyConnection using HTTP for sending and receiving messages.
+ */
 public class NtfyConnectionImpl implements NtfyConnection {
 
     private final HttpClient http = HttpClient.newHttpClient();
@@ -18,37 +21,48 @@ public class NtfyConnectionImpl implements NtfyConnection {
     private String currentTopic;
     private final ObjectMapper mapper = new ObjectMapper();
 
+    /** Loads configuration from environment variables. */
     public NtfyConnectionImpl() {
         Dotenv dotenv = Dotenv.load();
         this.hostName = Objects.requireNonNull(dotenv.get("HOST_NAME"));
         this.userId = Objects.requireNonNull(dotenv.get("USER_ID"), "USER_ID");
         this.currentTopic = dotenv.get("DEFAULT_TOPIC", "mytopic");
     }
 
+    /** Creates connection with a custom host, default user and topic. */
     public NtfyConnectionImpl(String hostName) {
         this.hostName = hostName;
         this.userId = "testuser";
         this.currentTopic = "mytopic";
     }
 
+    /** Creates connection with custom host, user, and topic. */
     public NtfyConnectionImpl(String hostName, String userId, String topic) {
         this.hostName = hostName;
         this.userId = userId;
         this.currentTopic = topic;
     }
 
+    /** Returns the user ID. */
     public String getUserId() {
         return userId;
     }
 
+    /** Returns the current topic. */
     public String getCurrentTopic() {
         return currentTopic;
     }
 
+    /** Sets the current topic. */
     public void setCurrentTopic(String topic) {
         this.currentTopic = topic;
     }
 
+    /**
+     * Sends a message asynchronously to the current topic.
+     * @param message message to send
+     * @param callback called with true if successful, false otherwise
+     */
     @Override
     public void send(String message, Consumer<Boolean> callback) {
         HttpRequest httpRequest = HttpRequest.newBuilder()
@@ -67,6 +81,10 @@ public void send(String message, Consumer<Boolean> callback) {
                 .thenAccept(callback);
     }
 
+    /**
+     * Receives messages from the current topic asynchronously.
+     * @param messageHandler called for each received message
+     */
     @Override
     public void receive(Consumer<NtfyMessageDto> messageHandler) {
         HttpRequest httpRequest = HttpRequest.newBuilder()

src/main/java/com/example/NtfyMessageDto.java

@@ -2,6 +2,9 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 
+/**
+ * Data transfer object for messages from the Ntfy server.
+ */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public record NtfyMessageDto(String id, long time, String event, String topic, String message) {
 }

src/test/java/com/example/HelloModelTest.java

@@ -23,8 +23,11 @@ static void initToolkit() {
     }
 
 
+    /**
+     * Verifies that a valid message is sent successfully and captured by the connection spy.
+     */
     @Test
-    @DisplayName("Should send message successfully when message is valid")
+    @DisplayName("Should send message successfully when message is valid.")
     void shouldSendValidMessageSuccessfully() throws InterruptedException {
         // Arrange
         var spy = new NtfyConnectionSpy();
@@ -43,8 +46,11 @@ void shouldSendValidMessageSuccessfully() throws InterruptedException {
         assertThat(spy.message).isEqualTo("Hello World");
     }
 
+    /**
+     * Ensures the message input field is cleared after a successful send operation.
+     */
     @Test
-    @DisplayName("Should clear message field after successful send")
+    @DisplayName("Should clear message field after successful send.")
     void shouldClearMessageFieldAfterSuccessfulSend() throws InterruptedException {
         // Arrange
         var spy = new NtfyConnectionSpy();
@@ -63,6 +69,9 @@ void shouldClearMessageFieldAfterSuccessfulSend() throws InterruptedException {
         assertThat(model.getMessageToSend()).isEmpty();
     }
 
+    /**
+     * Confirms that sending an empty string returns false and does not trigger a send.
+     */
     @Test
     @DisplayName("Should return false when sending empty string")
     void shouldReturnFalseForEmptyMessage() throws InterruptedException {
@@ -88,6 +97,9 @@ void shouldReturnFalseForEmptyMessage() throws InterruptedException {
         assertThat(spy.message).isNull();
     }
 
+    /**
+     * Confirms that sending a null message returns false and does not trigger a send.
+     */
     @Test
     @DisplayName("Should return false when sending null message")
     void shouldReturnFalseForNullMessage() throws InterruptedException {
@@ -113,6 +125,9 @@ void shouldReturnFalseForNullMessage() throws InterruptedException {
         assertThat(spy.message).isNull();
     }
 
+    /**
+     * Ensures failed sends are handled gracefully: callback receives false, message is retained.
+     */
     @Test
     @DisplayName("Should handle failed send and keep message")
     void shouldHandleFailedSendGracefully() throws InterruptedException {
@@ -145,6 +160,9 @@ public void receive(Consumer<NtfyMessageDto> messageHandler) { }
         assertThat(model.getMessageToSend()).isEqualTo("Fail this message");
     }
 
+    /**
+     * Verifies multiple sequential sends are processed correctly in order.
+     */
     @Test
     @DisplayName("Should handle multiple sequential sends correctly")
     void shouldHandleMultipleSequentialSends() throws InterruptedException {
@@ -177,6 +195,9 @@ void shouldHandleMultipleSequentialSends() throws InterruptedException {
         assertThat(spy.message).isEqualTo("Second");
     }
 
+    /**
+     * Ensures exceptions during send are caught and result in a failed callback (false).
+     */
     @Test
     @DisplayName("Should handle exceptions during send gracefully")
     void shouldHandleExceptionsDuringSend() throws InterruptedException {
@@ -219,8 +240,9 @@ public void receive(Consumer<NtfyMessageDto> messageHandler) { }
         }
     }
 
-    // ========== RECEIVE MESSAGE TESTS ==========
-
+    /**
+     * Verifies that a valid incoming message is added to the observable message list.
+     */
     @Test
     @DisplayName("Should add received message to message list")
     void shouldAddReceivedMessageToList() throws InterruptedException {
@@ -249,6 +271,9 @@ void shouldAddReceivedMessageToList() throws InterruptedException {
         assertThat(model.getMessages()).contains(message);
     }
 
+    /**
+     * Ensures null messages received from the connection are ignored and not added.
+     */
     @Test
     @DisplayName("Should ignore null received messages")
     void shouldIgnoreNullReceivedMessages() throws InterruptedException {
@@ -273,6 +298,9 @@ void shouldIgnoreNullReceivedMessages() throws InterruptedException {
         assertThat(model.getMessages()).isEmpty();
     }
 
+    /**
+     * Confirms messages with blank or empty content are filtered out and not added.
+     */
     @Test
     @DisplayName("Should ignore messages with blank or empty content")
     void shouldIgnoreBlankOrEmptyMessages() throws InterruptedException {
@@ -301,6 +329,9 @@ void shouldIgnoreBlankOrEmptyMessages() throws InterruptedException {
         assertThat(model.getMessages()).isEmpty();
     }
 
+    /**
+     * Verifies multiple incoming messages are added in the correct arrival order.
+     */
     @Test
     @DisplayName("Should add multiple received messages in correct order")
     void shouldAddMultipleMessagesInOrder() throws InterruptedException {
@@ -337,8 +368,10 @@ void shouldAddMultipleMessagesInOrder() throws InterruptedException {
         assertThat(model.getMessages().get(2)).isEqualTo(message3);
     }
 
-    // ========== INTEGRATION TESTS ==========
 
+    /**
+     * Integration test: verifies message is successfully sent to a mocked Ntfy server via HTTP.
+     */
     @Test
     @DisplayName("Should send message to fake server successfully")
     void shouldSendMessageToFakeServer(WireMockRuntimeInfo wmRuntimeInfo) throws InterruptedException {

src/test/java/com/example/NtfyConnectionSpy.java

@@ -2,23 +2,29 @@
 
 import java.util.function.Consumer;
 
+/**
+ * Spy for testing NtfyConnection: captures sent messages and simulates incoming ones.
+ */
 public class NtfyConnectionSpy implements NtfyConnection{
 
     String message;
     Consumer<NtfyMessageDto> handler;
 
+    /** Captures message and calls callback with true on a background thread. */
     @Override
     public void send(String message, Consumer<Boolean> callback) {
         this.message = message;
         new Thread(() -> callback.accept(true)).start();
     }
 
 
+    /** Saves the handler for incoming messages. */
     @Override
     public void receive(Consumer<NtfyMessageDto> messageHandler) {
         this.handler = messageHandler;
     }
 
+    /** Triggers the saved handler with the given message, if there is any. */
     public void simulateIncoming(NtfyMessageDto msg) {
         if (handler != null) handler.accept(msg);
     }