From 1da542de684c3d2f20e322c6549dbb22456114ca Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sat, 19 Nov 2022 12:38:48 +0100 Subject: [PATCH] some more docs --- fsrc-core/src/event_man.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/fsrc-core/src/event_man.rs b/fsrc-core/src/event_man.rs index 4ae0765..3219c0b 100644 --- a/fsrc-core/src/event_man.rs +++ b/fsrc-core/src/event_man.rs @@ -13,8 +13,8 @@ doc = ::embed_doc_image::embed_image!("event_man_arch", "images/event_man_arch.p to enable." )] //! One common use case for satellite systems is to offer a light-weight publish-subscribe mechanism -//! and IPC mechanism for software and hardware events which are also packaged as telemetry or can -//! trigger a system response. +//! and IPC mechanism for software and hardware events which are also packaged as telemetry (TM) or +//! can trigger a system response. //! //! The following graph shows how the event flow for such a setup could look like: //! @@ -208,6 +208,8 @@ impl EventManager { impl EventManager { + /// Create an event manager where the sender table will be the [DefaultSenderTableProvider] + /// and the listener table will be the [DefaultListenerTableProvider]. pub fn new(event_receiver: Box>) -> Self { let listener_table = Box::new(DefaultListenerTableProvider::default()); let sender_table =