diff --git a/src/script/sscsm/sscsm_controller.h b/src/script/sscsm/sscsm_controller.h index e2a7585ae0..e96e4fea90 100644 --- a/src/script/sscsm/sscsm_controller.h +++ b/src/script/sscsm/sscsm_controller.h @@ -13,6 +13,14 @@ class SSCSMEnvironment; class StupidChannel; +/** + * The purpose of this class is to: + * * Be the RAII owner of the SSCSM process. + * * Send events to SSCSM process, and process requests. (`runEvent`) + * * Hide details (e.g. that it is a separate process, or that it has to do IPC calls). + * + * See also SSCSMEnvironment for other side. + */ class SSCSMController { std::unique_ptr m_thread; diff --git a/src/script/sscsm/sscsm_environment.h b/src/script/sscsm/sscsm_environment.h index fc072cbac7..1839ae8bda 100644 --- a/src/script/sscsm/sscsm_environment.h +++ b/src/script/sscsm/sscsm_environment.h @@ -14,8 +14,14 @@ #include "sscsm_irequest.h" #include "../scripting_sscsm.h" -// The thread that runs SSCSM code. -// Meant to be replaced by a sandboxed process. +/** The thread that runs SSCSM code. + * + * Meant to be replaced by a sandboxed process. + * + * RAII-owns and abstracts away resources to communicate to the main process / thread. + * + * See also SSCSMController for other side. + */ class SSCSMEnvironment : public Thread { std::shared_ptr m_channel;