- Documentation Comment Improvements

Author: LK-Simon

src/ESPressio_IObservable.hpp

@@ -20,6 +20,7 @@ namespace ESPressio {
                 virtual IObserver* GetObserver() = 0;
         };
 
+        /// An `IObservable` is an object that can be observed by any number of `IObserver` descendant types
         class IObservable {
             public:
                 virtual ~IObservable() = default;

src/ESPressio_IObserver.hpp

@@ -4,6 +4,9 @@ namespace ESPressio {
 
     namespace Observable {
 
+        /// An `IObserver` is an object that can observe an `IObservable`
+        /// You MUST inherit from this type for ANY object from which you intend to Observe any `IObservable` descendant types
+        /// This is required to satisfy the `dynamic_cast` requirements of the `Observable` class, and cannot be avoided due to C++ language limitations.
         class IObserver {
             public:
                 virtual ~IObserver() = default;

src/ESPressio_Observable.hpp

@@ -11,6 +11,10 @@ namespace ESPressio {
 
     namespace Observable {
 
+        /// An `Observable` is an object that can be observed by any number of `IObserver` descendant types
+        /// This is a concrete implementation of `IObservable`, but it is NOT Thread-Safe.
+        /// Registering or Unregistering Observers while Observers are being notified can lead to undefined behavior.
+        /// If you need a Thread-Safe Implementation, install the `ESPressio-ObservableTS` package and use its implementation instead.
         class Observable : public IObservable {
             private:
                 std::vector<IObserverHandle*> _observers;