Skip to content

Commit 75ba8ea

Browse files
phip1611phip1611
committed
uefi: doc: Parameters -> Arguments
This is to streamline the wild mixture of different headings.
1 parent 90c5ba4 commit 75ba8ea

File tree

12 files changed

+42
-42
lines changed

12 files changed

+42
-42
lines changed

‎uefi/src/boot.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ pub(crate) fn memory_map_size() -> MemoryMapMeta {
310310
/// the right allocation size for the memory map to prevent
311311
/// [`Status::BUFFER_TOO_SMALL`].
312312
///
313-
/// # Parameters
313+
/// # Arguments
314314
///
315315
/// - `mt`: The memory type for the backing memory on the UEFI heap.
316316
/// Usually, this is [`MemoryType::LOADER_DATA`]. You can also use a

‎uefi/src/mem/memory_map/impl_.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ pub(crate) struct MemoryMapBackingMemory(NonNull<[u8]>);
275275
impl MemoryMapBackingMemory {
276276
/// Constructs a new [`MemoryMapBackingMemory`].
277277
///
278-
/// # Parameters
278+
/// # Arguments
279279
/// - `memory_type`: The memory type for the memory map allocation.
280280
/// Typically, [`MemoryType::LOADER_DATA`] for regular UEFI applications.
281281
pub(crate) fn new(memory_type: MemoryType) -> crate::Result<Self> {

‎uefi/src/proto/ata/mod.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pub struct AtaRequestBuilder<'a> {
4343
impl<'a> AtaRequestBuilder<'a> {
4444
/// Creates a new [`AtaRequestBuilder`] with the specified alignment, command, and protocol.
4545
///
46-
/// # Parameters
46+
/// # Arguments
4747
/// - `io_align`: The I/O buffer alignment required for the ATA controller.
4848
/// - `command`: The ATA command byte specifying the operation to execute.
4949
/// - `protocol`: The protocol type for the command (e.g., DMA, UDMA, etc.).
@@ -89,7 +89,7 @@ impl<'a> AtaRequestBuilder<'a> {
8989

9090
/// Creates a builder for a UDMA read operation.
9191
///
92-
/// # Parameters
92+
/// # Arguments
9393
/// - `io_align`: The I/O buffer alignment required for the ATA controller.
9494
/// - `command`: The ATA command byte specifying the read operation.
9595
///
@@ -104,7 +104,7 @@ impl<'a> AtaRequestBuilder<'a> {
104104

105105
/// Creates a builder for a UDMA write operation.
106106
///
107-
/// # Parameters
107+
/// # Arguments
108108
/// - `io_align`: The I/O buffer alignment required for the ATA controller.
109109
/// - `command`: The ATA command byte specifying the write operation.
110110
///
@@ -196,7 +196,7 @@ impl<'a> AtaRequestBuilder<'a> {
196196

197197
/// Uses a user-supplied buffer for reading data from the device.
198198
///
199-
/// # Parameters
199+
/// # Arguments
200200
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] that will be used to store data read from the device.
201201
///
202202
/// # Returns
@@ -216,7 +216,7 @@ impl<'a> AtaRequestBuilder<'a> {
216216

217217
/// Adds a newly allocated read buffer to the built ATA request.
218218
///
219-
/// # Parameters
219+
/// # Arguments
220220
/// - `len`: The size of the buffer (in bytes) to allocate for receiving data.
221221
///
222222
/// # Returns
@@ -234,7 +234,7 @@ impl<'a> AtaRequestBuilder<'a> {
234234

235235
/// Uses a user-supplied buffer for writing data to the device.
236236
///
237-
/// # Parameters
237+
/// # Arguments
238238
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] containing the data to be written to the device.
239239
///
240240
/// # Returns
@@ -255,7 +255,7 @@ impl<'a> AtaRequestBuilder<'a> {
255255
/// Adds a newly allocated write buffer to the built ATA request that is filled from the
256256
/// given data buffer. (Done for memory alignment and lifetime purposes)
257257
///
258-
/// # Parameters
258+
/// # Arguments
259259
/// - `data`: A slice of bytes representing the data to be written.
260260
///
261261
/// # Returns

‎uefi/src/proto/ata/pass_thru.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ impl AtaPassThru {
6262
/// The `ata` api will validate that your buffers have the correct alignment and error
6363
/// if they don't.
6464
///
65-
/// # Parameters
65+
/// # Arguments
6666
/// - `len`: The size (in bytes) of the buffer to allocate.
6767
///
6868
/// # Returns
@@ -162,7 +162,7 @@ impl AtaDevice<'_> {
162162

163163
/// Executes a command on the device.
164164
///
165-
/// # Parameters
165+
/// # Arguments
166166
/// - `req`: The request structure containing details about the command to execute.
167167
///
168168
/// # Returns

‎uefi/src/proto/device_path/util.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ impl DevicePathUtilities {
1919
/// Retrieves the size of the specified device path in bytes, including the
2020
/// end-of-device-path node.
2121
///
22-
/// # Parameters
22+
/// # Arguments
2323
/// - `device_path`: A reference to the [`DevicePath`] whose size is to be determined.
2424
///
2525
/// # Returns
@@ -31,7 +31,7 @@ impl DevicePathUtilities {
3131

3232
/// Creates a new device path by appending the second device path to the first.
3333
///
34-
/// # Parameters
34+
/// # Arguments
3535
/// - `path0`: A reference to the base device path.
3636
/// - `path1`: A reference to the device path to append.
3737
///
@@ -54,7 +54,7 @@ impl DevicePathUtilities {
5454

5555
/// Creates a new device path by appending a device node to the base device path.
5656
///
57-
/// # Parameters
57+
/// # Arguments
5858
/// - `basepath`: A reference to the base device path.
5959
/// - `node`: A reference to the device node to append.
6060
///
@@ -77,7 +77,7 @@ impl DevicePathUtilities {
7777

7878
/// Creates a new device path by appending the specified device path instance to the base path.
7979
///
80-
/// # Parameters
80+
/// # Arguments
8181
/// - `basepath`: A reference to the base device path.
8282
/// - `instance`: A reference to the device path instance to append.
8383
///

‎uefi/src/proto/media/disk_info.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ impl DiskInfo {
9595

9696
/// Performs an inquiry command on the disk device.
9797
///
98-
/// # Parameters
98+
/// # Arguments
9999
/// - `bfr`: A mutable byte buffer to store the inquiry data.
100100
///
101101
/// # Returns
@@ -116,7 +116,7 @@ impl DiskInfo {
116116

117117
/// Performs an identify command on the disk device.
118118
///
119-
/// # Parameters
119+
/// # Arguments
120120
/// - `bfr`: A mutable byte buffer to store the identification data.
121121
///
122122
/// # Returns
@@ -137,7 +137,7 @@ impl DiskInfo {
137137

138138
/// Retrieves sense data from the disk device.
139139
///
140-
/// # Parameters
140+
/// # Arguments
141141
/// - `bfr`: A mutable byte buffer to store the sense data.
142142
///
143143
/// # Returns

‎uefi/src/proto/media/load_file.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pub struct LoadFile(LoadFileProtocol);
4343
impl LoadFile {
4444
/// Causes the driver to load a specified file.
4545
///
46-
/// # Parameters
46+
/// # Arguments
4747
/// - `file_path` The device specific path of the file to load.
4848
/// - `boot_policy` The [`BootPolicy`] to use.
4949
///
@@ -121,7 +121,7 @@ pub struct LoadFile2(LoadFile2Protocol);
121121
impl LoadFile2 {
122122
/// Causes the driver to load a specified file.
123123
///
124-
/// # Parameters
124+
/// # Arguments
125125
/// - `file_path` The device specific path of the file to load.
126126
///
127127
/// # Errors

‎uefi/src/proto/nvme/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ pub struct NvmeRequestBuilder<'buffers> {
8787
impl<'buffers> NvmeRequestBuilder<'buffers> {
8888
/// Creates a new builder for configuring an NVMe request.
8989
///
90-
/// # Parameters
90+
/// # Arguments
9191
/// - `io_align`: Memory alignment requirements for buffers.
9292
/// - `opcode`: The opcode for the NVMe command.
9393
/// - `queue_type`: Specifies the type of queue the command should be placed into.
@@ -142,7 +142,7 @@ impl<'buffers> NvmeRequestBuilder<'buffers> {
142142

143143
/// Uses a user-supplied buffer for reading data from the device.
144144
///
145-
/// # Parameters
145+
/// # Arguments
146146
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] that will be used to store data read from the device.
147147
///
148148
/// # Returns
@@ -165,7 +165,7 @@ impl<'buffers> NvmeRequestBuilder<'buffers> {
165165

166166
/// Adds a newly allocated transfer buffer to the built NVMe request.
167167
///
168-
/// # Parameters
168+
/// # Arguments
169169
/// - `len`: The size of the buffer (in bytes) to allocate for receiving data.
170170
///
171171
/// # Returns
@@ -183,7 +183,7 @@ impl<'buffers> NvmeRequestBuilder<'buffers> {
183183

184184
/// Uses a user-supplied metadata buffer.
185185
///
186-
/// # Parameters
186+
/// # Arguments
187187
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] that will be used to store metadata.
188188
///
189189
/// # Returns
@@ -206,7 +206,7 @@ impl<'buffers> NvmeRequestBuilder<'buffers> {
206206

207207
/// Adds a newly allocated metadata buffer to the built NVMe request.
208208
///
209-
/// # Parameters
209+
/// # Arguments
210210
/// - `len`: The size of the buffer (in bytes) to allocate for storing metadata.
211211
///
212212
/// # Returns

‎uefi/src/proto/nvme/pass_thru.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ impl NvmePassThru {
6969
/// The `nvme` api will validate that your buffers have the correct alignment and error
7070
/// if they don't.
7171
///
72-
/// # Parameters
72+
/// # Arguments
7373
/// - `len`: The size (in bytes) of the buffer to allocate.
7474
///
7575
/// # Returns
@@ -148,7 +148,7 @@ impl NvmeNamespace<'_> {
148148

149149
/// Sends an NVM Express command to this namespace (Namespace ID ≥ 1).
150150
///
151-
/// # Parameters
151+
/// # Arguments
152152
/// - `req`: The [`NvmeRequest`] containing the command and associated data to send to the namespace.
153153
///
154154
/// # Returns

‎uefi/src/proto/scsi/mod.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ pub struct ScsiRequestBuilder<'a> {
4646
impl ScsiRequestBuilder<'_> {
4747
/// Creates a new instance with the specified data direction and alignment.
4848
///
49-
/// # Parameters
49+
/// # Arguments
5050
/// - `direction`: Specifies the direction of data transfer (READ, WRITE, or BIDIRECTIONAL).
5151
/// - `io_align`: Specifies the required alignment for data buffers. (SCSI Controller specific!)
5252
#[must_use]
@@ -84,7 +84,7 @@ impl ScsiRequestBuilder<'_> {
8484
/// - READ
8585
/// - MODE_SENSE
8686
///
87-
/// # Parameters
87+
/// # Arguments
8888
/// - `io_align`: Specifies the required alignment for data buffers.
8989
#[must_use]
9090
pub fn read(io_align: u32) -> Self {
@@ -97,7 +97,7 @@ impl ScsiRequestBuilder<'_> {
9797
/// - WRITE
9898
/// - MODE_SELECT
9999
///
100-
/// # Parameters
100+
/// # Arguments
101101
/// - `io_align`: Specifies the required alignment for data buffers.
102102
#[must_use]
103103
pub fn write(io_align: u32) -> Self {
@@ -109,7 +109,7 @@ impl ScsiRequestBuilder<'_> {
109109
/// Some examples of SCSI bidirectional commands are:
110110
/// - SEND DIAGNOSTIC
111111
///
112-
/// # Parameters
112+
/// # Arguments
113113
/// - `io_align`: Specifies the required alignment for data buffers.
114114
#[must_use]
115115
pub fn bidirectional(io_align: u32) -> Self {
@@ -120,7 +120,7 @@ impl ScsiRequestBuilder<'_> {
120120
impl<'a> ScsiRequestBuilder<'a> {
121121
/// Sets a timeout for the SCSI request.
122122
///
123-
/// # Parameters
123+
/// # Arguments
124124
/// - `timeout`: A [`Duration`] representing the maximum time allowed for the request.
125125
/// The value is converted to 100-nanosecond units.
126126
///
@@ -139,7 +139,7 @@ impl<'a> ScsiRequestBuilder<'a> {
139139

140140
/// Uses a user-supplied buffer for reading data from the device.
141141
///
142-
/// # Parameters
142+
/// # Arguments
143143
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] that will be used to store data read from the device.
144144
///
145145
/// # Returns
@@ -159,7 +159,7 @@ impl<'a> ScsiRequestBuilder<'a> {
159159

160160
/// Adds a newly allocated read buffer to the built SCSI request.
161161
///
162-
/// # Parameters
162+
/// # Arguments
163163
/// - `len`: The size of the buffer (in bytes) to allocate for receiving data.
164164
///
165165
/// # Returns
@@ -177,7 +177,7 @@ impl<'a> ScsiRequestBuilder<'a> {
177177

178178
/// Adds a newly allocated sense buffer to the built SCSI request.
179179
///
180-
/// # Parameters
180+
/// # Arguments
181181
/// - `len`: The size of the buffer (in bytes) to allocate for receiving sense data.
182182
///
183183
/// # Returns
@@ -195,7 +195,7 @@ impl<'a> ScsiRequestBuilder<'a> {
195195

196196
/// Uses a user-supplied buffer for writing data to the device.
197197
///
198-
/// # Parameters
198+
/// # Arguments
199199
/// - `bfr`: A mutable reference to an [`AlignedBuffer`] containing the data to be written to the device.
200200
///
201201
/// # Returns
@@ -216,7 +216,7 @@ impl<'a> ScsiRequestBuilder<'a> {
216216
/// Adds a newly allocated write buffer to the built SCSI request that is filled from the
217217
/// given data buffer. (Done for memory alignment and lifetime purposes)
218218
///
219-
/// # Parameters
219+
/// # Arguments
220220
/// - `data`: A slice of bytes representing the data to be written.
221221
///
222222
/// # Returns
@@ -235,7 +235,7 @@ impl<'a> ScsiRequestBuilder<'a> {
235235

236236
/// Uses a user-supplied Command Data Block (CDB) buffer.
237237
///
238-
/// # Parameters
238+
/// # Arguments
239239
/// - `data`: A mutable reference to an [`AlignedBuffer`] containing the CDB to be sent to the device.
240240
///
241241
/// # Returns
@@ -259,7 +259,7 @@ impl<'a> ScsiRequestBuilder<'a> {
259259
/// Adds a newly allocated Command Data Block (CDB) buffer to the built SCSI request that is filled from the
260260
/// given data buffer. (Done for memory alignment and lifetime purposes)
261261
///
262-
/// # Parameters
262+
/// # Arguments
263263
/// - `data`: A slice of bytes representing the command to be sent.
264264
///
265265
/// # Returns

0 commit comments

Comments
 (0)