Tidying

src/DebugServer/DebugServerComponent.cpp

@@ -26,6 +26,7 @@ namespace Bloom::DebugServer
                 this->server->run();
                 this->eventListener->dispatchCurrentEvents();
             }
+
         } catch (const std::exception& exception) {
             Logger::error("DebugServer fatal error: " + std::string(exception.what()));
         }

src/DebugServer/DebugServerComponent.hpp

@@ -21,12 +21,8 @@ namespace Bloom::DebugServer
 {
     /**
      * The DebugServer exposes the connected target to third-party debugging software such as IDEs.
-     * The DebugServer runs on a dedicated thread which is kicked off shortly after the TargetController has been
-     * started.
      *
-     * All supported DebugServers should be derived from this class.
+     * See documentation in src/DebugServer/README.md for more.
-     *
-     * Bloom currently only supports one DebugServer - the GdbRspDebugServer.
      */
     class DebugServerComponent: public Thread
     {

src/DebugServer/ServerInterface.hpp

@@ -23,7 +23,9 @@ namespace Bloom::DebugServer
          * Called repeatedly in an infinite loop when the DebugServerComponent is running. The server should serve
          * from here.
          *
-         * This function should return when any blocking operation is interrupted via an EventNotifier instance.
+         * For servicing DebugServer events, the implementation should either service them here or return from here
+         * upon an event being triggered. Returning from this function will allow DebugServerComponent::run() to
+         * process any pending events. See the DebugServer documentation in src/DebugServer/README.md for more.
          */
         virtual void run() = 0;