diff --git a/Cargo.toml b/Cargo.toml index 2c582f7..563e0ba 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -36,3 +36,7 @@ version = "1.0.1" default = ["std"] std = ["chrono/std", "chrono/clock", "alloc"] alloc = ["postcard/alloc"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "doc_cfg"] diff --git a/src/ecss.rs b/src/ecss.rs index 06026d1..d6139be 100644 --- a/src/ecss.rs +++ b/src/ecss.rs @@ -158,7 +158,7 @@ macro_rules! sp_header_impls { pub(crate) use ccsds_impl; pub(crate) use sp_header_impls; -/// Generic trait for ECSS enumeration which consist of a PFC field denoting their length +/// Generic trait for ECSS enumeration which consist of a PFC field denoting their bit length /// and an unsigned value. The trait makes no assumptions about the actual type of the unsigned /// value and only requires implementors to implement a function which writes the enumeration into /// a raw byte format. diff --git a/src/lib.rs b/src/lib.rs index 63b0175..aa160ec 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -65,6 +65,7 @@ pub struct SizeMissmatch { pub found: usize, pub expected: usize, } + #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum ByteConversionError { /// The passed slice is too small. Returns the found and expected minimum size diff --git a/src/tc.rs b/src/tc.rs index 2231777..a177ae8 100644 --- a/src/tc.rs +++ b/src/tc.rs @@ -370,6 +370,7 @@ impl<'slice> PusTc<'slice> { } #[cfg(feature = "alloc")] + #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))] pub fn append_to_vec(&self, vec: &mut Vec) -> Result { let sph_zc = crate::zc::SpHeader::from(self.sp_header); let mut appended_len = PUS_TC_MIN_LEN_WITHOUT_APP_DATA; diff --git a/src/time.rs b/src/time.rs index d9605f1..676d7ee 100644 --- a/src/time.rs +++ b/src/time.rs @@ -47,6 +47,7 @@ pub enum TimestampError { } #[cfg(feature = "std")] +#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))] pub fn seconds_since_epoch() -> f64 { SystemTime::now() .duration_since(SystemTime::UNIX_EPOCH) @@ -133,6 +134,7 @@ impl CdsShortTimeProvider { } #[cfg(feature = "std")] + #[cfg_attr(doc_cfg, doc(cfg(feature = "std")))] pub fn from_now() -> Result { let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?; let epoch = now.as_secs(); @@ -151,6 +153,7 @@ impl CdsShortTimeProvider { } #[cfg(feature = "std")] + #[cfg_attr(doc_cfg, doc(cfg(feature = "std")))] pub fn update_from_now(&mut self) -> Result<(), SystemTimeError> { let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?; let epoch = now.as_secs(); @@ -168,6 +171,7 @@ impl CdsShortTimeProvider { } #[cfg(feature = "std")] + #[cfg_attr(doc_cfg, doc(cfg(feature = "std")))] pub fn ms_of_day_using_sysclock() -> u32 { Self::ms_of_day(seconds_since_epoch()) } diff --git a/src/tm.rs b/src/tm.rs index 3322243..da40589 100644 --- a/src/tm.rs +++ b/src/tm.rs @@ -352,6 +352,7 @@ impl<'slice> PusTm<'slice> { /// Append the raw PUS byte representation to a provided [alloc::vec::Vec] #[cfg(feature = "alloc")] + #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))] pub fn append_to_vec(&self, vec: &mut Vec) -> Result { let sph_zc = crate::zc::SpHeader::from(self.sp_header); let mut appended_len =