From 80e4e1eb78898879eed11648808ca6b65eecb304 Mon Sep 17 00:00:00 2001
From: WBoerenkamps <wrj.boerenkamps@student.avans.nl>
Date: Tue, 12 Nov 2024 15:08:37 +0100
Subject: removed auto from code

---
 src/crepe/api/EventHandler.h | 80 ++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 77 insertions(+), 3 deletions(-)

(limited to 'src/crepe/api/EventHandler.h')

diff --git a/src/crepe/api/EventHandler.h b/src/crepe/api/EventHandler.h
index eea1c79..5b9ac0d 100644
--- a/src/crepe/api/EventHandler.h
+++ b/src/crepe/api/EventHandler.h
@@ -4,35 +4,109 @@
 #include <typeindex>
 #include "Event.h"
 
+/**
+ * \brief A type alias for an event handler function.
+ * 
+ * The EventHandler is a std::function that takes an EventType reference and returns a boolean value 
+ * indicating whether the event was successfully handled.
+ * 
+ * \tparam EventType The type of event this handler will handle.
+ */
 template <typename EventType>
 using EventHandler = std::function<bool(const EventType & e)>;
 
+/**
+ * \class IEventHandlerWrapper
+ * \brief An abstract base class for event handler wrappers.
+ * 
+ * This class provides the interface for handling events. Derived classes must implement the
+ * `call()` method to process events and the `get_type()` method to return the handler's type.
+ */
 class IEventHandlerWrapper {
 public:
+    /**
+     * \brief Virtual destructor for IEventHandlerWrapper.
+     */
     virtual ~IEventHandlerWrapper() = default;
 
+    /**
+     * \brief Executes the handler with the given event.
+     * 
+     * This method calls the `call()` method of the derived class, passing the event to the handler.
+     * 
+     * \param e The event to be processed.
+     * \return A boolean value indicating whether the event is handled.
+     */
     bool exec(const Event & e);
 
+    /**
+     * \brief Get the type of the event handler.
+     * 
+     * This method returns the type of the event handler as a string.
+     * 
+     * \return A string representing the handler's type.
+     */
     virtual std::string get_type() const = 0;
 
 private:
+    /**
+     * \brief The method responsible for handling the event.
+     * 
+     * This method is implemented by derived classes to process the event.
+     * 
+     * \param e The event to be processed.
+     * \return A boolean value indicating whether the event is handled.
+     */
     virtual bool call(const Event & e) = 0;
 };
 
+/**
+ * \class EventHandlerWrapper
+ * \brief A wrapper for event handler functions.
+ * 
+ * This class wraps an event handler function of a specific event type. It implements the 
+ * `call()` and `get_type()` methods to allow the handler to be executed and its type to be 
+ * queried.
+ * 
+ * \tparam EventType The type of event this handler will handle.
+ */
 template <typename EventType>
 class EventHandlerWrapper : public IEventHandlerWrapper {
 public:
+    /**
+     * \brief Constructs an EventHandlerWrapper with a given handler.
+     * 
+     * The constructor takes an event handler function and stores it in the wrapper.
+     * 
+     * \param handler The event handler function.
+     */
     explicit EventHandlerWrapper(const EventHandler<EventType> & handler)
         : m_handler(handler), m_handler_type(m_handler.target_type().name()) {
     }
 
 private:
+    /**
+     * \brief Calls the stored event handler with the event.
+     * 
+     * This method casts the event to the appropriate type and calls the handler.
+     * 
+     * \param e The event to be handled.
+     * \return A boolean value indicating whether the event is handled.
+     */
     bool call(const Event & e) override {
         return m_handler(static_cast<const EventType &>(e));
     }
 
+    /**
+     * \brief Returns the type of the handler.
+     * 
+     * This method returns a string representing the type of the event handler.
+     * 
+     * \return The handler type as a string.
+     */
     std::string get_type() const override { return m_handler_type; }
-
-    EventHandler<EventType> m_handler;
-    const std::string m_handler_type;
+	//! The event handler function.
+    EventHandler<EventType> m_handler; 
+	//! The type name of the handler function.
+    const std::string m_handler_type; 
 };
-- 
cgit v1.2.3