Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit bfd2f4f

Browse files
More documentation cleanup
1 parent fd9c4ea commit bfd2f4f

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

‎src/proto/console/gop.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -458,21 +458,21 @@ impl From<u32> for BltPixel {
458458
}
459459
}
460460

461-
/// Region of the BltBuffer which we are operating on
461+
/// Region of the `BltBuffer` which we are operating on
462462
///
463-
/// Some Blt operations can operate on either the full BltBuffer or a
463+
/// Some `Blt` operations can operate on either the full `BltBuffer` or a
464464
/// sub-rectangle of it, but require the stride to be known in the latter case.
465465
#[derive(Clone, Copy, Debug)]
466466
pub enum BltRegion {
467-
/// Operate on the full BltBuffer
467+
/// Operate on the full `BltBuffer`
468468
Full,
469469

470-
/// Operate on a sub-rectangle of the BltBuffer
470+
/// Operate on a sub-rectangle of the `BltBuffer`
471471
SubRectangle {
472-
/// Coordinate of the rectangle in the BltBuffer
472+
/// Coordinate of the rectangle in the `BltBuffer`
473473
coords: (usize, usize),
474474

475-
/// Stride (length of each row of the BltBuffer) in **pixels**
475+
/// Stride (length of each row of the `BltBuffer`) in **pixels**
476476
px_stride: usize,
477477
},
478478
}

‎src/proto/media/file/dir.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ use crate::{Result, Status};
33
use core::ffi::c_void;
44
use core::result;
55

6-
/// File wrapper for handling directories
6+
/// `File` wrapper for handling directories
77
///
8-
/// The File abstraction can handle directories, but does so in a very roundabout way. A dedicated
9-
/// abstraction for directory handling that wraps the unintuitive File API is therefore desirable.
8+
/// The `File` abstraction can handle directories, but does so in a very roundabout way.
9+
/// A dedicated abstraction for directory handling is therefore desirable.
1010
pub struct Directory<'a>(File<'a>);
1111

1212
impl<'a> Directory<'a> {
@@ -48,7 +48,7 @@ impl<'a> Directory<'a> {
4848
/// an empty optional.
4949
///
5050
/// The input buffer must be correctly aligned for a `FileInfo`. You can query the required
51-
/// alignment through the Align trait (`<FileInfo as Align>::alignment()`).
51+
/// alignment through the `Align` trait (`<FileInfo as Align>::alignment()`).
5252
///
5353
/// # Arguments
5454
/// * `buffer` The target buffer of the read operation

‎uefi-macros/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ pub fn unsafe_guid(args: TokenStream, input: TokenStream) -> TokenStream {
102102
result.into()
103103
}
104104

105-
/// Custom derive for the Protocol trait
105+
/// Custom derive for the `Protocol` trait
106106
#[proc_macro_derive(Protocol)]
107107
pub fn derive_protocol(item: TokenStream) -> TokenStream {
108108
// Parse the input using Syn
@@ -112,7 +112,7 @@ pub fn derive_protocol(item: TokenStream) -> TokenStream {
112112
let ident = item.ident.clone();
113113
let (impl_generics, ty_generics, where_clause) = item.generics.split_for_impl();
114114
let result = quote! {
115-
// Mark this as a Protocol implementation
115+
// Mark this as a `Protocol` implementation
116116
impl #impl_generics crate::proto::Protocol for #ident #ty_generics #where_clause {}
117117

118118
// Most UEFI functions expect to be called on the bootstrap processor.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /