Add doc for CorePlugin

Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>

1 files changed, 10 insertions, 1 deletions

diff --git a/crates/core/tedge_core/src/core_task.rs b/crates/core/tedge_core/src/core_task.rs
index ac009c84..b9441aa2 100644
--- a/crates/core/tedge_core/src/core_task.rs
+++ b/crates/core/tedge_core/src/core_task.rs
@@ -2,12 +2,19 @@ use async_trait::async_trait;
 use tedge_api::{address::ReplySenderFor, message::StopCore, plugin::Handle, Plugin, PluginError};
 use tracing::trace;
 
-#[derive(Clone)]
+/// "Core" Plugin
+///
+/// A type that pretends to be a plugin which handles all communication with thin-edge.io itself.
+/// This type implements the normal [Plugin](tedge_api::plugin::Plugin) trait so that it can be run
+/// like a normal plugin, but has special privileged access to the runtime of thin-edge.io, for
+/// example to shut down the application.
+/// #[derive(Clone)]
 pub struct CorePlugin {
     sender: tokio::sync::mpsc::Sender<CoreInternalMessage>,
 }
 
 impl CorePlugin {
+    /// Instantiate new CorePlugin
     pub fn new(sender: tokio::sync::mpsc::Sender<CoreInternalMessage>) -> Self {
         Self { sender }
     }
@@ -17,6 +24,8 @@ impl tedge_api::plugin::PluginDeclaration for CorePlugin {
     type HandledMessages = (StopCore,);
 }
 
+/// Internal message that is sent between the `CorePlugin` shim and the thin-edge.io runtime
+/// implementation.
 pub enum CoreInternalMessage {
     Stop,
 }