Added a bit of documentation and some cleanup

psychic-ui/Div.hpp

@@ -74,9 +74,19 @@ namespace psychic_ui {
 
     public:
         Div();
+
+        /**
+         * Just as a safety for now, delete the copy constructor
+         * because I don't see a reason why we would need it.
+         */
         Div(const Div &) = delete;
-        ~Div();
 
+        ~Div() override;
+
+        /**
+         * Just as a safety for now, delete the copy constructor
+         * because I don't see a reason why we would need it.
+         */
         Div &operator=(const Div &) = delete;
 
         /**

psychic-ui/Window.cpp

@@ -1,6 +1,8 @@
 #include <iostream>
 #include "GrBackendSurface.h"
 #include "Window.hpp"
+#include <SkSurface.h>
+
 
 namespace psychic_ui {
 
@@ -84,9 +86,7 @@ namespace psychic_ui {
             throw std::runtime_error("Skia surface requested without a context");
         }
 
-        if (_sk_surface) {
-            delete _sk_surface;
-        }
+        delete _sk_surface;
 
         GrGLFramebufferInfo framebufferInfo{};
         framebufferInfo.fFBOID = 0;  // assume default framebuffer
@@ -98,6 +98,7 @@ namespace psychic_ui {
             kSkia8888_GrPixelConfig,
             framebufferInfo
         );
+
         _sk_surface = SkSurface::MakeFromBackendRenderTarget(
             _sk_context,
             backendRenderTarget,
@@ -517,8 +518,4 @@ namespace psychic_ui {
 
     // endregion
 
-    // region Event Callbacks
-
-    // endregion
-
 }

psychic-ui/applications/SDL2Application.cpp

@@ -139,8 +139,6 @@ namespace psychic_ui {
             SDL_GL_SetAttribute(SDL_GL_MULTISAMPLESAMPLES, 4);
         }
 
-        //glEnable(GL_MULTISAMPLE);
-
         // WINDOW FLAGS
 
         uint32_t windowFlags = 0;

psychic-ui/signals/Observer.hpp

@@ -24,7 +24,7 @@ namespace psychic_ui {
     public:
         Observer() = default;
 
-        virtual ~Observer() {
+        ~Observer() {
             for (auto &slot: slots) {
                 slot->disconnect();
             }

psychic-ui/signals/Slot.hpp

@@ -12,26 +12,65 @@ namespace psychic_ui {
      */
     class SlotBase {
     public:
+        /**
+         * Disconnects this slot, removing it from the signal
+         */
         virtual void disconnect() = 0;
     };
 
     /**
-     * Subscription for a signal, this is used to wrap a callback in a shared/weak pointer.
+     * Subscription for a signal
+     * This is used in the Signal class to keep a list of callbacks to execute
+     * when the signal is emitted and also to hold as a shared_ptr in an Observer
+     * derived class in order to automatically clean subscriptions in scenarios where
+     * the Observer has a shorter life span than the Signal source. When a Signal
+     * source has a shorter life, there is no need to hold a pointer to the slot as
+     * the Signal will be destroyed first, thus destroying the slots and their callbacks.
+     *
+     * When keeping a pointer to a slot for manual disconnection, type the Slot template
+     * with the same type parameters as the Signal. For example, a `Signal<float, int>` will
+     * return a `shared_ptr<Slot<float, int>>` when subscribing.
      */
     template<class... T>
     class Slot : public SlotBase {
     public:
+        /**
+         * Creates a slot from a signal and callback
+         * The pointer to the signal is used in order to be able to disconnect
+         * the slot from its `disconnect` method.
+         *
+         * You should not have to create slots manually, this is called
+         * by the Signal class when subscribing.
+         *
+         * @param signal Signal that this slot is attached to
+         * @param callback Callback to execute when the signal is emited
+         */
         explicit Slot(Signal<T...> *signal, std::function<void(T...)> callback) :
             notify(callback),
             _signal(signal) {}
 
+        /**
+         * Disconnect the slot
+         * This will unsubscribe from the signal, effectively removing this
+         * slot from the vector in the Signal instance.
+         */
         void disconnect() override {
             _signal->unsubscribe(this);
             _signal = nullptr;
         }
 
-        std::function<void(T...)> notify;
+        /**
+         * Function to ba called when the signal is emitted.
+         * This should not be called manually, it is called by
+         * the Signal class
+         */
+        std::function<void(T...)> notify{nullptr};
+
     private:
+        /**
+         * Signal that owns this slot
+         * This pointer is used to allow disconnecting from the slot.
+         */
         Signal<T...> *_signal;
     };