From d62b521d3d6200bf59a97ce2cb9ced322088d990 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Sat, 5 Aug 2023 12:00:08 +0100
Subject: [PATCH] docs: add new module docs
---
src/gb.rs | 2 ++
src/mmu.rs | 2 ++
src/pad.rs | 2 ++
src/ppu.rs | 2 ++
4 files changed, 8 insertions(+)
diff --git a/src/gb.rs b/src/gb.rs
index b63a5478..10f21993 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,
diff --git a/src/mmu.rs b/src/mmu.rs
index ab6afb88..716a7520 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 eff48b55..f58c1265 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 9443a014..1d85fde6 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,
--
GitLab