From 39c534882be8deb4ebc0ae3239968a13a66e266f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Tue, 23 Jul 2024 07:44:28 +0100
Subject: [PATCH] chore: improved overall module structure

---
 src/inst.rs                     | 2 ++
 src/lib.rs                      | 2 +-
 src/{license.rs => licensee.rs} | 2 ++
 src/rom.rs                      | 4 +++-
 src/test.rs                     | 2 +-
 src/timer.rs                    | 2 ++
 src/util.rs                     | 2 ++
 7 files changed, 13 insertions(+), 3 deletions(-)
 rename src/{license.rs => licensee.rs} (99%)

diff --git a/src/inst.rs b/src/inst.rs
index 8b059a59..36164bd8 100644
--- a/src/inst.rs
+++ b/src/inst.rs
@@ -1,3 +1,5 @@
+//! CPU instructions implementation for the Sharp LR35902.
+
 use crate::cpu::Cpu;
 
 pub const INSTRUCTIONS: [Instruction; 256] = [
diff --git a/src/lib.rs b/src/lib.rs
index a1dd6646..adb34f3f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -14,7 +14,7 @@ pub mod gb;
 pub mod gen;
 pub mod info;
 pub mod inst;
-pub mod license;
+pub mod licensee;
 pub mod macros;
 pub mod mmu;
 pub mod pad;
diff --git a/src/license.rs b/src/licensee.rs
similarity index 99%
rename from src/license.rs
rename to src/licensee.rs
index 222cc507..126983b3 100644
--- a/src/license.rs
+++ b/src/licensee.rs
@@ -1,3 +1,5 @@
+//! Game Boy licensee vendors information and static enumerations.
+
 use std::fmt::{self, Display, Formatter};
 
 #[cfg(feature = "wasm")]
diff --git a/src/rom.rs b/src/rom.rs
index 0da4c4ce..5e9a6e22 100644
--- a/src/rom.rs
+++ b/src/rom.rs
@@ -1,3 +1,5 @@
+//! Cartridge (ROM) related functions and structures.
+
 use core::fmt;
 use std::{
     cmp::max,
@@ -10,7 +12,7 @@ use crate::{
     debugln,
     error::Error,
     gb::GameBoyMode,
-    license::Licensee,
+    licensee::Licensee,
     mmu::BusComponent,
     util::read_file,
     warnln,
diff --git a/src/test.rs b/src/test.rs
index a65e5b77..dc4c28cf 100644
--- a/src/test.rs
+++ b/src/test.rs
@@ -80,7 +80,7 @@ mod tests {
         },
         data::BootRom,
         gb::GameBoyMode,
-        license::Licensee,
+        licensee::Licensee,
         rom::{RamSize, Region, RomSize},
     };
 
diff --git a/src/timer.rs b/src/timer.rs
index 311c4370..c70b8ff1 100644
--- a/src/timer.rs
+++ b/src/timer.rs
@@ -1,3 +1,5 @@
+//! Timer functions and structures.
+
 use crate::{
     consts::{DIV_ADDR, TAC_ADDR, TIMA_ADDR, TMA_ADDR},
     mmu::BusComponent,
diff --git a/src/util.rs b/src/util.rs
index be45a0e2..814ccafe 100644
--- a/src/util.rs
+++ b/src/util.rs
@@ -1,3 +1,5 @@
+//! Assorted utility functions and structures.
+
 use std::{
     cell::RefCell,
     fs::File,
-- 
GitLab