Skip to content

Commit 5d5f882

Browse files
committed
multiboot2-common: doc fixes
1 parent 73a8a4a commit 5d5f882

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

multiboot2-common/src/iter.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ use core::marker::PhantomData;
77
use core::mem;
88

99
/// Iterates over the tags (modelled by [`DynSizedStructure`]) of the underlying
10-
/// byte slice. Each tag is expected to have the same common [`Header`].
10+
/// byte slice. Each tag is expected to have the same common [`Header`] with
11+
/// the corresponding ABI guarantees.
1112
///
1213
/// As the iterator emits elements of type [`DynSizedStructure`], users should
13-
/// casted them to specific [`Tag`]s using [`DynSizedStructure::cast`] following
14-
/// a user policy. This can for example happen on the basis of some ID.
14+
/// cast them to specific [`Tag`]s using [`DynSizedStructure::cast`] following
15+
/// a user-specific policy. This can for example happen on the basis of some ID.
16+
///
17+
/// This iterator also emits end tags and doesn't treat them separately.
1518
///
1619
/// This type ensures the memory safety guarantees promised by this crates
1720
/// documentation.

0 commit comments

Comments
 (0)