alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-24 00:31:34 +11:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for submodules

Browse source
This commit is contained in:
Corwin Kuiper 2021-06-03 19:22:08 +01:00
parent e6affbd0a9
commit 6eb13473bb
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
agb/src/lib.rs
View file

@ -7,16 +7,27 @@
#![test_runner(crate::test_runner)] #![test_runner(crate::test_runner)]
#![reexport_test_harness_main = "test_main"] #![reexport_test_harness_main = "test_main"]
//! # agb
//! `agb` is a library for making games on the Game Boy Advance using the Rust
//! programming language. It attempts to be a high level abstraction over the
//! internal workings of the Game Boy Advance whilst still being high
//! performance and memory efficient.
/// Implements everything relating to things that are displayed on screen.
pub mod display; pub mod display;
/// Button inputs to the system.
pub mod input; pub mod input;
/// Implements sound output.
pub mod sound; pub mod sound;
mod interrupt; mod interrupt;
mod memory_mapped; mod memory_mapped;
/// Implements logging to the mgba emulator.
pub mod mgba; pub mod mgba;
pub mod number; mod number;
mod single; mod single;
/// System BIOS calls / syscalls.
pub mod syscall; pub mod syscall;
#[cfg(not(test))] #[cfg(not(test))]