From 3a4b10011b764f6634c0ba3ccaae8d27c1a6d61f Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Mon, 1 Dec 2025 01:37:27 +0100 Subject: [PATCH 1/4] ver: Rustdoc Signed-off-by: Daniel Maslowski --- src/ver.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/ver.rs b/src/ver.rs index 44485f5..3dd2e8c 100644 --- a/src/ver.rs +++ b/src/ver.rs @@ -1,3 +1,7 @@ +//! Common struct for version information +//! +//! This kind of version information occurs in multiple places. + use core::fmt::{self, Display}; use serde::{Deserialize, Serialize}; use zerocopy_derive::{FromBytes, Immutable, IntoBytes}; From fc53104399f5af821eb9559ae0d928263f43e4ae Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Mon, 1 Dec 2025 01:37:40 +0100 Subject: [PATCH 2/4] dir: fix Rustdoc Signed-off-by: Daniel Maslowski --- src/dir.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/dir.rs b/src/dir.rs index e425251..a280f67 100644 --- a/src/dir.rs +++ b/src/dir.rs @@ -1,8 +1,9 @@ -/// Directories for ME generation 2 and 3 -/// -/// There are multiple kinds of partitioning schemes, and some partitions may -/// contain directories, but directories could also be referenced by other data -/// structures, such as in the case of IFWI, so they are separate here. +//! Directories for ME generation 2 and 3 +//! +//! There are multiple kinds of partitioning schemes, and some partitions may +//! contain directories, but directories could also be referenced by other data +//! structures, such as in the case of IFWI, so they are separate here. + pub mod gen2; pub mod gen3; pub mod man; From 254edfa28bb9cca2e8b58754189085c7c1507c29 Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Mon, 1 Dec 2025 01:37:52 +0100 Subject: [PATCH 3/4] part: fix Rustdoc Signed-off-by: Daniel Maslowski --- src/part.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/part.rs b/src/part.rs index 80f9a19..730e474 100644 --- a/src/part.rs +++ b/src/part.rs @@ -1,8 +1,9 @@ -/// Partitioning for ME generation 2 and 3 -/// -/// There are multiple kinds of partitioning schemes, and some partitions may -/// contain directories, but directories could also be referenced by other data -/// structures, such as in the case of IFWI, so they are separate. +//! Partitioning for ME generation 2 and 3 +//! +//! There are multiple kinds of partitioning schemes, and some partitions may +//! contain directories, but directories could also be referenced by other data +//! structures, such as in the case of IFWI, so they are separate. + pub mod fpt; pub mod gen2; pub mod gen3; From 1e17f2404425a347825e6d05941f0da836e7f9cc Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Mon, 1 Dec 2025 01:38:03 +0100 Subject: [PATCH 4/4] meta: rework Rustdoc Signed-off-by: Daniel Maslowski --- src/meta.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/meta.rs b/src/meta.rs index 1fd49f6..d9bbd0a 100644 --- a/src/meta.rs +++ b/src/meta.rs @@ -1,4 +1,6 @@ -//! Adapted from me_cleaner, a map of key hashes => metadata (variant + version). +//! Map of key hashes => metadata (variant + version) +//! +//! This has been adapted from me_cleaner. use std::fmt::Display;