From 7e551a9ab7c5874532ff97c47659ebac9f01e156 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sat, 3 Feb 2024 13:31:06 +0100 Subject: [PATCH] fix docs --- satrs-core/src/pool.rs | 6 +++--- satrs-core/src/pus/mod.rs | 9 +++++---- satrs-core/src/pus/scheduler.rs | 10 +++++----- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/satrs-core/src/pool.rs b/satrs-core/src/pool.rs index 17c7ea8..0111d18 100644 --- a/satrs-core/src/pool.rs +++ b/satrs-core/src/pool.rs @@ -221,7 +221,7 @@ pub trait PoolProviderMemInPlace { } pub trait PoolProviderMemInPlaceWithGuards: PoolProviderMemInPlace { - /// This function behaves like [PoolProvider::read], but consumes the provided address + /// This function behaves like [PoolProviderMemInPlace::read], but consumes the provided address /// and returns a RAII conformant guard object. /// /// Unless the guard [PoolRwGuard::release] method is called, the data for the @@ -231,8 +231,8 @@ pub trait PoolProviderMemInPlaceWithGuards: PoolProviderMemInPlace { /// manual deletion is necessary when returning from a processing function prematurely. fn read_with_guard(&mut self, addr: StoreAddr) -> PoolGuard; - /// This function behaves like [PoolProvider::modify], but consumes the provided address - /// and returns a RAII conformant guard object. + /// This function behaves like [PoolProviderMemInPlace::modify], but consumes the provided + /// address and returns a RAII conformant guard object. /// /// Unless the guard [PoolRwGuard::release] method is called, the data for the /// given address will be deleted automatically when the guard is dropped. diff --git a/satrs-core/src/pus/mod.rs b/satrs-core/src/pus/mod.rs index 46697bd..b13cfba 100644 --- a/satrs-core/src/pus/mod.rs +++ b/satrs-core/src/pus/mod.rs @@ -712,7 +712,7 @@ pub mod std_mod { /// Converter structure for PUS telecommands which are stored inside a `Vec` structure. /// Please note that this structure is not able to convert TCs which are stored inside a - /// [SharedPool]. + /// [SharedStaticMemoryPool]. #[derive(Default, Clone)] pub struct EcssTcInVecConverter { pub pus_tc_raw: Option>, @@ -745,9 +745,10 @@ pub mod std_mod { } } - /// Converter structure for PUS telecommands which are stored inside a [SharedPool] structure. - /// This is useful if run-time allocation for these packets should be avoided. Please note - /// that this structure is not able to convert TCs which are stored as a `Vec`. + /// Converter structure for PUS telecommands which are stored inside + /// [SharedStaticMemoryPool] structure. This is useful if run-time allocation for these + /// packets should be avoided. Please note that this structure is not able to convert TCs which + /// are stored as a `Vec`. pub struct EcssTcInSharedStoreConverter { shared_tc_store: SharedStaticMemoryPool, pus_buf: Vec, diff --git a/satrs-core/src/pus/scheduler.rs b/satrs-core/src/pus/scheduler.rs index a8a22ef..d0f6a72 100644 --- a/satrs-core/src/pus/scheduler.rs +++ b/satrs-core/src/pus/scheduler.rs @@ -315,11 +315,11 @@ pub mod alloc_mod { /// This is the core data structure for scheduling PUS telecommands with [alloc] support. /// /// It is assumed that the actual telecommand data is stored in a separate TC pool offering - /// a [crate::pool::PoolProvider] API. This data structure just tracks the store addresses and their - /// release times and offers a convenient API to insert and release telecommands and perform - /// other functionality specified by the ECSS standard in section 6.11. The time is tracked - /// as a [spacepackets::time::UnixTimestamp] but the only requirement to the timekeeping of - /// the user is that it is convertible to that timestamp. + /// a [crate::pool::PoolProviderMemInPlace] API. This data structure just tracks the store + /// addresses and their release times and offers a convenient API to insert and release + /// telecommands and perform other functionality specified by the ECSS standard in section 6.11. + /// The time is tracked as a [spacepackets::time::UnixTimestamp] but the only requirement to + /// the timekeeping of the user is that it is convertible to that timestamp. /// /// The standard also specifies that the PUS scheduler can be enabled and disabled. /// A disabled scheduler should still delete commands where the execution time has been reached