Samuka007/asterinas
1
0
Fork 0
mirror of https://github.com/asterinas/asterinas.git synced 2025-06-18 03:56:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos in API documentation

Browse Source
This commit is contained in:
Jianfeng Jiang
2024-05-30 11:25:58 +00:00
committed by Tate, Hongliang Tian
parent 6e59617fc7
commit 33a7da9991
65 changed files with 415 additions and 323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
kernel/comps/block/src/bio.rs
View File

@ -73,7 +73,7 @@ impl Bio {
///
/// Returns a `BioWaiter` to the caller to wait for its completion.
///
/// # Panic
/// # Panics
///
/// The caller must not submit a `Bio` more than once. Otherwise, a panic shall be triggered.
pub fn submit(&self, block_device: &dyn BlockDevice) -> Result<BioWaiter, BioEnqueueError> {
@ -107,7 +107,7 @@ impl Bio {
///
/// Returns the result status of the `Bio`.
///
/// # Panic
/// # Panics
///
/// The caller must not submit a `Bio` more than once. Otherwise, a panic shall be triggered.
pub fn submit_sync(
@ -169,7 +169,7 @@ impl BioWaiter {
/// Gets the `index`-th `Bio` request associated with `self`.
///
/// # Panic
/// # Panics
///
/// If the `index` is out of bounds, this method will panic.
pub fn req(&self, index: usize) -> Bio {
@ -178,7 +178,7 @@ impl BioWaiter {
/// Returns the status of the `index`-th `Bio` request associated with `self`.
///
/// # Panic
/// # Panics
///
/// If the `index` is out of bounds, this method will panic.
pub fn status(&self, index: usize) -> BioStatus {

2
kernel/comps/block/src/request_queue.rs
View File

@ -182,7 +182,7 @@ impl BioRequest {
///
/// The merged `SubmittedBio` can only be placed at the front or back.
///
/// # Panic
/// # Panics
///
/// If the `SubmittedBio` can not be merged, this method will panic.
pub fn merge_bio(&mut self, rq_bio: SubmittedBio) {