From 4b7b4ddd645774c5f231486a62b17509f7111db8 Mon Sep 17 00:00:00 2001
From: Vladimir Orany <vladimir@orany.cz>
Date: Tue, 3 Dec 2024 10:32:01 +0100
Subject: [PATCH] bit more docs

---
 .../com/agorapulse/worker/queue/QueueMessage.java    | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java b/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java
index 4234bb1e..23b4c2c9 100644
--- a/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java
+++ b/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java
@@ -47,8 +47,20 @@ static <T> QueueMessage<T> requeueIfDeleted(T message, Runnable doDelete, Runnab
         return DefaultQueueMessage.requeueIfDeleted(message, doDelete, doRequeue);
     }
 
+    /**
+     * Returns the payload of the message.
+     * @return the payload of the message
+     */
     T getMessage();
+
+    /**
+     * Deletes the message from the queue.
+     */
     void delete();
+
+    /**
+     * Requeues the message. Depending on the type of the message it might not be requeued if it was not deleted.
+     */
     void requeue();
 
 }