diff --git a/src/gb.rs b/src/gb.rs index 7b29e97db47acefb0bf71cb5ae42ca9a7b1590bc..ad3cfa0096d2b7a9621368effecc9e4082a241ad 100644 --- a/src/gb.rs +++ b/src/gb.rs @@ -1,3 +1,5 @@ +//! Main GameBoy emulation entrypoint functions and structures. + use std::{ cell::RefCell, collections::VecDeque, @@ -261,8 +263,8 @@ impl Default for GameBoyConfig { } } -/// Aggregation structure tha allows the bundling of -/// all the components of a gameboy into a single a +/// Aggregation structure allowing the bundling of +/// all the components of a GameBoy into a single a /// single element for easy access. pub struct Components { pub ppu: Ppu, diff --git a/src/mmu.rs b/src/mmu.rs index ab6afb8825d07bcfb9d96ba09e6406f3fef20b82..716a7520638f660781b229f7f770067a3888ac5e 100644 --- a/src/mmu.rs +++ b/src/mmu.rs @@ -1,3 +1,5 @@ +//! MMU (Memory Management Unit) functions and structures. + use std::{cell::RefCell, rc::Rc}; use crate::{ diff --git a/src/pad.rs b/src/pad.rs index eff48b55578fa515959d3b538711223cea827438..f58c1265ac94b8b24f40b2d11f939783c5e1bd4d 100644 --- a/src/pad.rs +++ b/src/pad.rs @@ -1,3 +1,5 @@ +//! Gamepad related functions and structures. + use crate::warnln; #[cfg(feature = "wasm")] diff --git a/src/ppu.rs b/src/ppu.rs index 9443a01452ce062bb69cec33239c81497165ffff..1d85fde69e16697d27b3c106d4d7d9f608dcbeca 100644 --- a/src/ppu.rs +++ b/src/ppu.rs @@ -1,3 +1,5 @@ +//! PPU (Picture Processing Unit) functions and structures. + use core::fmt; use std::{ borrow::BorrowMut,