From f87a7f44ca8ea3496b228671eb349d2f0c53bc51 Mon Sep 17 00:00:00 2001 From: "Tristan B. Kildaire" Date: Mon, 27 Dec 2021 13:02:32 +0200 Subject: [PATCH] Added some Javadocs --- source/eventy/engine.d | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/source/eventy/engine.d b/source/eventy/engine.d index ffa87a1..04b7777 100644 --- a/source/eventy/engine.d +++ b/source/eventy/engine.d @@ -243,6 +243,14 @@ public final class Engine : Thread } } + /** + * Creates a new queue with the given id + * and then adds it + * + * @param id the id of the new queue to add + * @throws EventyException if a queue with + * the given id already exists + */ public void addQueue(ulong id) { /* Create a new queue with the given id */ @@ -267,6 +275,15 @@ public final class Engine : Thread queueLock.unlock(); } + /** + * Given an id, this will return + * the Queue associated with said + * id + * + * @param id the id of the Queue + * @returns The Queue if found but + * null otherwise + */ public Queue findQueue(ulong id) { /* Lock the queue collection */ @@ -289,9 +306,10 @@ public final class Engine : Thread return matchedQueue; } + /* TODO: Add coumentation */ public ulong[] getTypes() { /* TODO: Implement me */ return null; } -} \ No newline at end of file +}