diff --git a/src/gb.rs b/src/gb.rs index af8e2348c827f80d161c9a3259e11f5863c9dd75..1f2d742976e4327fb4d78c57ba6a5763fc5c4542 100644 --- a/src/gb.rs +++ b/src/gb.rs @@ -1,4 +1,16 @@ -//! Main Game Boy emulation entrypoint functions and structures. +//! Game Boy emulation entrypoint and associated functions and structures. +//! +//! Most of the meaningful publicly available functions and structures to build +//! a working emulator should be present here. +//! +//! # Examples +//! +//! ```rust +//! use boytacean::gb::GameBoy; +//! let game_boy = GameBoy::new(None); +//! game_boy.load(false).unwrap(); +//! game_boy.tick(); +//! ``` use std::{ collections::VecDeque, diff --git a/src/ppu.rs b/src/ppu.rs index a69bd019fbf5eadeea9ed3d5f849b71c37d7f7b5..af0fd2dd45cbb02635237cb97f2209037db94fd0 100644 --- a/src/ppu.rs +++ b/src/ppu.rs @@ -343,6 +343,7 @@ pub struct PpuRegisters { /// Outputs the screen as a RGB 8 bit frame buffer. /// /// # Basic usage +/// /// ```rust /// use boytacean::ppu::Ppu; /// let mut ppu = Ppu::default();