(src) fixed some faults about documentation

pku-minic · Jan 5, 2022 · dc5f765 · dc5f765
1 parent eca83a9
commit dc5f765
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/src/front/mod.rs b/src/front/mod.rs
@@ -4,7 +4,7 @@
 //!
 //! * Tokens ([`token`]) and abstract syntax tree ([`ast`]) of Koopa IR.
 //! * [`Span`](span::Span) struct for holding source code locations.
-//! * Lexer ([`Lexer`](lexer::Lexer)), parser ([`Parser`](parser::parser))
+//! * Lexer ([`Lexer`](lexer::Lexer)), parser ([`Parser`](parser::Parser))
 //!   and analyzer ([`Builder`](builder::Builder)) of Koopa IR.
 //! * Koopa IR frontend driver ([`Driver`]).
 //!

diff --git a/src/ir/layout.rs b/src/ir/layout.rs
@@ -76,8 +76,8 @@ impl Default for Layout {
 /// You can push or insert new basic blocks to the list by calling
 /// [`push_key_front`](BasicBlockList::push_key_front),
 /// [`push_key_back`](BasicBlockList::push_key_back),
-/// [`insert_key_before`](BasicBlockList::insert_key_before) or
-/// [`insert_key_after`](BasicBlockList::insert_key_after).
+/// [`insert_key_before`](key_node_list::CursorMut::insert_key_before) or
+/// [`insert_key_after`](key_node_list::CursorMut::insert_key_after).
 pub type BasicBlockList = KeyNodeList<BasicBlock, BasicBlockNode, BasicBlockMap>;
 
 type InstBBCell = Weak<RefCell<HashMap<Value, BasicBlock>>>;
@@ -196,8 +196,8 @@ impl From<()> for BasicBlockNode {
 /// You can push or insert new instructions to the list by calling
 /// [`push_key_front`](BasicBlockList::push_key_front),
 /// [`push_key_back`](BasicBlockList::push_key_back),
-/// [`insert_key_before`](BasicBlockList::insert_key_before) or
-/// [`insert_key_after`](BasicBlockList::insert_key_after).
+/// [`insert_key_before`](key_node_list::CursorMut::insert_key_before) or
+/// [`insert_key_after`](key_node_list::CursorMut::insert_key_after).
 pub type InstList = KeyNodeList<Value, InstNode, InstMap>;
 
 /// The underlying hash map of the [`InstList`].

diff --git a/src/ir/mod.rs b/src/ir/mod.rs
@@ -4,8 +4,9 @@
 //! including:
 //!
 //! * Structs of Koopa IR programs ([`Program`]), functions ([`Function`],
-//!   [`FunctionData`]), basic blocks ([`BasicBlock`], [`BasicBlockData`])
-//!   and values ([`Value`], [`ValueData`]).
+//!   [`FunctionData`]), basic blocks ([`BasicBlock`],
+//!   [`BasicBlockData`](entities::BasicBlockData)) and values ([`Value`],
+//!   [`ValueData`](entities::ValueData)).
 //! * Types of IR values ([`Type`]).
 //! * IR builders and IR builder traits ([`builder`]).
 //!