[fix] cargo doc error

arceos-org · Dec 18, 2024 · a6e3acd · a6e3acd
1 parent 5861a3b
commit a6e3acd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,4 +6,6 @@
 
 RISC-V platform-level interrupt controller (PLIC) register definitions and basic operations.
 
-The official documentation: <https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc/>
+The official documentation: <https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc/>
+
+Ref: <https://github.com/YdrMaster/plic>
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,5 +1,5 @@
 //! RISC-V Platform-Level Interrupt Controller
-//! https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc
+//! <https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc>
 #![no_std]
 #![feature(const_option)]
 #![feature(const_nonnull_new)]
@@ -89,6 +89,7 @@ pub trait HartContext {
     fn index(self) -> usize;
 }
 
+/// Platform-Level Interrupt Controller.
 pub struct Plic {
     base: NonNull<PLICRegs>,
 }