Skip to content

Commit 62cb152

Browse files
bjzhjingrbradford
authored andcommitted
loader: Add inline links for loader trait and structs
As suggested by rust, it's good practice to add documentation to public items of a crate. Thus, add inline links for public traits and structs. Signed-off-by: Cathy Zhang <cathy.zhang@intel.com>
1 parent c39f0f8 commit 62cb152

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/loader/mod.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
//
88
// SPDX-License-Identifier: Apache-2.0 AND BSD-3-Clause
99

10+
//! Traits and Structs
11+
//! - [KernelLoader](trait.KernelLoader.html): load kernel image into guest memory
12+
//! - [KernelLoaderResult](struct.KernelLoaderResult.html): the structure which loader
13+
//! returns to VMM to assist zero page construction and boot environment setup
14+
//! - [Elf](struct.Elf.html): elf image loader
15+
//! - [BzImage](struct.BzImage.html): bzImage loader
16+
1017
extern crate vm_memory;
1118

1219
use std::error::{self, Error as KernelLoaderError};

0 commit comments

Comments
 (0)