Fix all doc warnings

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

View File

@ -309,7 +309,7 @@ impl UserContextApiInternal for UserContext {
}
}
/// As Osdev Wiki defines(https://wiki.osdev.org/Exceptions):
/// As Osdev Wiki defines(<https://wiki.osdev.org/Exceptions>):
/// CPU exceptions are classified as:
///
/// Faults: These can be corrected and the program may continue as if nothing happened.

View File

@ -7,7 +7,7 @@ use crate::arch::x86::device::io_port::{IoPort, ReadWriteAccess, WriteOnlyAccess
/// A serial port.
///
/// Serial ports are a legacy communications port common on IBM-PC compatible computers.
/// Ref: https://wiki.osdev.org/Serial_Ports
/// Ref: <https://wiki.osdev.org/Serial_Ports>
pub struct SerialPort {
pub data: IoPort<u8, ReadWriteAccess>,
pub int_en: IoPort<u8, WriteOnlyAccess>,

View File

@ -4,7 +4,7 @@
//! a prescaler and 3 independent frequency dividers. Each frequency divider has an output, which is
//! used to allow the timer to control external circuitry (for example, IRQ 0).
//!
//! Reference: https://wiki.osdev.org/Programmable_Interval_Timer
//! Reference: <https://wiki.osdev.org/Programmable_Interval_Timer>
//!
use crate::{

View File

@ -5,7 +5,7 @@
//! The format of the Asterinas command line string conforms
//! to the Linux kernel command line rules:
//!
//! https://www.kernel.org/doc/html/v6.4/admin-guide/kernel-parameters.html
//! <https://www.kernel.org/doc/html/v6.4/admin-guide/kernel-parameters.html>
//!
use alloc::{

View File

@ -9,7 +9,7 @@
//!
//! Use case:
//!
//! ```rust norun
//! ```rust no_run
//! #[derive(Debug)]
//! pub struct PciDeviceA {
//! common_device: PciCommonDevice,

View File

@ -103,7 +103,7 @@ impl Drop for IrqLine {
///
/// # Example
///
/// ``rust
/// ```rust
/// use aster_frame::irq;
///
/// {

View File

@ -3,10 +3,10 @@
//! Big zImage PE/COFF header generation.
//!
//! The definition of the PE/COFF header is in the Microsoft PE/COFF specification:
//! https://learn.microsoft.com/en-us/windows/win32/debug/pe-format
//! <https://learn.microsoft.com/en-us/windows/win32/debug/pe-format>
//!
//! The reference to the Linux PE header definition:
//! https://github.com/torvalds/linux/blob/master/include/linux/pe.h
//! <https://github.com/torvalds/linux/blob/master/include/linux/pe.h>
use std::{mem::size_of, ops::Range};