diff --git a/src/common.rs b/src/common.rs index e65066a..4cc0a68 100755 --- a/src/common.rs +++ b/src/common.rs @@ -10,7 +10,7 @@ use binrw::binrw; #[brw(repr(u8))] #[repr(u8)] #[derive(Copy, Clone)] -/// The language the game data is written for. +/// The language the game data is written for. Some of these languages are supported in the Global region. pub enum Language { /// Used for data that is language-agnostic, such as item data. None, @@ -44,10 +44,12 @@ pub fn get_language_code(lang: &Language) -> &'static str { } } +/// The region of the game. Used to denote the region a patch is meant for. #[binrw] #[brw(repr = i16)] #[derive(Debug, PartialEq, Eq)] pub enum Region { + /// The global region. Global = -1, // TODO: find patch codes for other regions :-) } diff --git a/src/lib.rs b/src/lib.rs index 4244538..b89a746 100755 --- a/src/lib.rs +++ b/src/lib.rs @@ -34,7 +34,7 @@ pub mod exl; /// Reading equipment and equipment-related data. pub mod equipment; -/// Common structures used by other modules. +/// Common structures, enumerations and functions used by many modules. pub mod common; /// Methods for installing game and boot patches.