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

Fix all doc warnings

Browse Source
This commit is contained in:
Zhang Junyang
2024-03-15 10:27:14 +08:00
committed by Tate, Hongliang Tian
parent 160cb9cdb5
commit b49e11a25e
15 changed files with 29 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
kernel/libs/aster-rights-proc/src/lib.rs
View File

@ -4,11 +4,11 @@
//! When use this crate, typeflags and typeflags-util should also be added as dependency.
//!
//! The require macro are used to ensure that an object has the enough capability to call the function.
//! The **require** macro can accept constraint [SomeRightSet] > [SomeRight],
//! which means the SomeRightSet should **contain** the SomeRight.
//! The **require** macro can also accept constraint [SomeRightSet] > [AnotherRightSet],
//! which means the SomeRightSet should **include** the AnotherRightSet. In this case, AnotherRightSet should be a **generic parameter**.
//! i.e., AnotherRightSet should occur the the generic param list of the function.
//! The **require** macro can accept constraint `SomeRightSet` > `SomeRight`,
//! which means the `SomeRightSet` should **contain** the `SomeRight`.
//! The **require** macro can also accept constraint `SomeRightSet` > `AnotherRightSet`,
//! which means the `SomeRightSet` should **include** the `AnotherRightSet`. In this case, `AnotherRightSet` should be a **generic parameter**.
//! i.e., `AnotherRightSet` should occur the the generic param list of the function.
//!
//! If there are multiple constraits, they can be seperated with `|`, which means all constraits should be satisfied.
//!

2
kernel/libs/aster-rights/src/lib.rs
View File

@ -55,7 +55,7 @@ pub type WriteOp = TRights![Write];
pub type FullOp = TRights![Read, Write, Dup];
/// Wrapper for TRights, used to bypass an error message from the Rust compiler,
/// the relevant issue is: https://github.com/rust-lang/rfcs/issues/2758
/// the relevant issue is: <https://github.com/rust-lang/rfcs/issues/2758>
///
/// Example:
///