Skip to content

Commit 0a027d0

Browse files
committed
uefi: improve doc for device path construction
1 parent 0bef927 commit 0a027d0

File tree

1 file changed

+10
-1
lines changed
  • uefi/src/proto/device_path

1 file changed

+10
-1
lines changed

uefi/src/proto/device_path/mod.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@
3737
//!
3838
//! # Types
3939
//!
40-
//! To represent device paths, this module provides several types:
40+
//! To represent device paths, this module provides several types, which are
41+
//! listed in the following. To construct device paths, please head to the
42+
//! [`build`] module.
4143
//!
4244
//! * [`DevicePath`] is the root type that represents a full device
4345
//! path, containing one or more device path instance. It ends with an
@@ -80,6 +82,13 @@
8082
//! Note: the API provided by this module is currently mostly limited to
8183
//! reading existing device paths rather than constructing new ones.
8284
//!
85+
//! # Submodules
86+
//!
87+
//! - utilities to construct device paths: [`build`]
88+
//! - utilities to transform device paths to a textual representation: [`text`]
89+
//! - DevicePathUtilities protocol:: [`util`]
90+
//!
91+
//!
8392
//! [`END_ENTIRE`]: DeviceSubType::END_ENTIRE
8493
//! [`END_INSTANCE`]: DeviceSubType::END_INSTANCE
8594
//! [`Protocol`]: crate::proto::Protocol

0 commit comments

Comments
 (0)