Force the compiler and clippy to return a warning when a function isn't documented

This commit is contained in:
Quentin Legot
2023-03-13 14:51:32 +01:00
parent 8126a9ac2e
commit 5a6a70f1b7
3 changed files with 31 additions and 1 deletions

View File

@ -1,5 +1,16 @@
#![warn(missing_docs)]
#![warn(clippy::missing_docs_in_private_items)]
//! Crate burritos ((BurritOS Using Rust Really Improves The Operating System)
//!
//! Burritos is an educational operating system written in Rust
//! running on RISC-V emulator.
/// Contain hardware simulated part of the machine
mod simulator;
mod kernel;
/// module containing useful tools which can be use in most part of the OS to ease the development of the OS
pub mod utility;
use kernel::system::System;
@ -7,5 +18,6 @@ use simulator::machine::Machine;
fn main() {
let machine = Machine::init_machine();
let _system = System::new(machine);
let mut system = System::new(machine);
system.freeze();
}