documentation for public interface of observer class

Christoph · Christoph · commit 35ae3af8b3dd · 2025-06-25T14:06:04.000+02:00
diff --git a/cppgp/util/observer.hpp b/cppgp/util/observer.hpp
@@ -5,6 +5,11 @@
 
 namespace gp::util {
 
+/**
+ * Interface to allow observation of a ISubject class.
+ * This class can subscribe at an ISubject and the provided function
+ * gets called by ISubject at certain events.
+ */
 class IObserver {
 public:
     /**
@@ -23,10 +28,17 @@ class IObserver {
 };
 
 
+/**
+ * Interface to allow notification of subscribed IObserver classes.
+ * It provides public functions for IObserver classes to subscribe
+ * and unsubscribe. Further, this class provides a protected member
+ * function notifyAll that notifies all subscribed IObserver classes.
+ */
 class ISubject {
 public:
     ISubject();
     ~ISubject();
+
     /**
      * \brief
      */
@@ -38,6 +50,9 @@ class ISubject {
     bool unsubscribe(const IObserver* const observer);
 
 protected:
+    /**
+     *
+     */
     void notifyAll();
 
 private:
