From 8db18136c14045311433a5624c48fb9b5d6d439a Mon Sep 17 00:00:00 2001
From: ChUrl <christoph.urlacher@protonmail.com>
Date: Thu, 8 Dec 2022 21:12:29 +0100
Subject: [PATCH] Cleanup SchedulerService.h

---
 src/kernel/service/SchedulerService.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/kernel/service/SchedulerService.h b/src/kernel/service/SchedulerService.h
index 61aa9e9..4da3663 100644
--- a/src/kernel/service/SchedulerService.h
+++ b/src/kernel/service/SchedulerService.h
@@ -25,7 +25,13 @@ public:
 
     MakeUnmovable(SchedulerService)
 
-    // Helper that directly constructs the thread, then readys it
+    /**
+     * Construct a thread inplace and add it to the schedulers ready queue.
+     *
+     * @tparam T The type of thread to construct
+     * @param args The arguments for the thread's constructor
+     * @return The constructed thread's id
+     */
     template<typename T, typename... Args>
     uint32_t ready(Args... args) {
         Memory::unique_ptr<Thread> thread = Memory::make_unique<T>(std::forward<Args>(args)...);