Initial work on adding documentation, reorganises modules

src/static_data/libraries/ability_library.rs

@@ -1,7 +1,8 @@
+use hashbrown::HashMap;
+
 use crate::static_data::Ability;
 use crate::static_data::DataLibrary;
 use crate::StringKey;
-use hashbrown::HashMap;
 
 #[derive(Debug)]
 pub struct AbilityLibrary {
@@ -34,9 +35,9 @@ impl DataLibrary<'_, Box<Ability>> for AbilityLibrary {
 
 #[cfg(test)]
 pub mod tests {
-    use crate::static_data::libraries::ability_library::AbilityLibrary;
-    use crate::static_data::libraries::data_library::DataLibrary;
-    use crate::static_data::species_data::ability::Ability;
+    use crate::static_data::Ability;
+    use crate::static_data::AbilityLibrary;
+    use crate::static_data::DataLibrary;
     use crate::StringKey;
 
     pub fn build() -> AbilityLibrary {

src/static_data/libraries/growth_rate_library.rs

@@ -1,9 +1,11 @@
+use std::fmt;
+use std::fmt::{Debug, Formatter};
+
+use hashbrown::HashMap;
+
 use crate::defines::LevelInt;
 use crate::static_data::GrowthRate;
 use crate::StringKey;
-use hashbrown::HashMap;
-use std::fmt;
-use std::fmt::{Debug, Formatter};
 
 pub struct GrowthRateLibrary {
     growth_rates: HashMap<StringKey, Box<dyn GrowthRate>>,
@@ -35,7 +37,7 @@ impl Debug for GrowthRateLibrary {
 
 #[cfg(test)]
 pub mod tests {
-    use crate::static_data::growth_rates::lookup_growth_rate::LookupGrowthRate;
+    use crate::static_data::growth_rates::LookupGrowthRate;
     use crate::static_data::libraries::growth_rate_library::GrowthRateLibrary;
 
     pub fn build() -> GrowthRateLibrary {

src/static_data/libraries/item_library.rs

@@ -1,7 +1,8 @@
+use hashbrown::HashMap;
+
 use crate::static_data::DataLibrary;
 use crate::static_data::Item;
 use crate::StringKey;
-use hashbrown::HashMap;
 
 #[derive(Debug)]
 pub struct ItemLibrary {
@@ -34,11 +35,12 @@ impl DataLibrary<'_, Box<Item>> for ItemLibrary {
 
 #[cfg(test)]
 pub mod tests {
-    use crate::static_data::items::item::Item;
-    use crate::static_data::items::item_category::{BattleItemCategory, ItemCategory};
+    use hashbrown::HashSet;
+
     use crate::static_data::libraries::data_library::DataLibrary;
     use crate::static_data::libraries::item_library::ItemLibrary;
-    use hashbrown::HashSet;
+    use crate::static_data::Item;
+    use crate::static_data::{BattleItemCategory, ItemCategory};
 
     fn build_item() -> Item {
         Item::new(

src/static_data/libraries/mod.rs

@@ -1,19 +1,28 @@
-pub mod ability_library;
-pub mod data_library;
-pub mod growth_rate_library;
-pub mod item_library;
-pub mod library_settings;
-pub mod move_library;
-pub mod species_library;
-pub mod static_data;
-pub mod type_library;
-
+#[doc(inline)]
 pub use ability_library::AbilityLibrary;
+#[doc(inline)]
 pub use data_library::DataLibrary;
+#[doc(inline)]
 pub use growth_rate_library::GrowthRateLibrary;
+#[doc(inline)]
 pub use item_library::ItemLibrary;
+#[doc(inline)]
 pub use library_settings::LibrarySettings;
+#[doc(inline)]
 pub use move_library::MoveLibrary;
+#[doc(inline)]
 pub use species_library::SpeciesLibrary;
+#[doc(inline)]
 pub use static_data::StaticData;
+#[doc(inline)]
 pub use type_library::TypeLibrary;
+
+mod ability_library;
+mod data_library;
+mod growth_rate_library;
+mod item_library;
+mod library_settings;
+mod move_library;
+mod species_library;
+pub(crate) mod static_data;
+mod type_library;

src/static_data/libraries/move_library.rs

@@ -1,7 +1,8 @@
+use hashbrown::HashMap;
+
 use crate::static_data::DataLibrary;
 use crate::static_data::MoveData;
 use crate::StringKey;
-use hashbrown::HashMap;
 
 #[derive(Debug)]
 pub struct MoveLibrary {
@@ -34,11 +35,12 @@ impl DataLibrary<'_, MoveData> for MoveLibrary {
 
 #[cfg(test)]
 pub mod tests {
+    use hashbrown::HashSet;
+
     use crate::static_data::libraries::data_library::DataLibrary;
     use crate::static_data::libraries::move_library::MoveLibrary;
-    use crate::static_data::moves::move_data::{MoveCategory, MoveData, MoveTarget};
+    use crate::static_data::{MoveCategory, MoveData, MoveTarget};
     use crate::StringKey;
-    use hashbrown::HashSet;
 
     fn build_move() -> MoveData {
         MoveData::new(

src/static_data/libraries/species_library.rs

@@ -1,7 +1,8 @@
+use hashbrown::HashMap;
+
 use crate::static_data::DataLibrary;
 use crate::static_data::Species;
 use crate::StringKey;
-use hashbrown::HashMap;
 
 #[derive(Debug)]
 pub struct SpeciesLibrary {
@@ -34,13 +35,14 @@ impl<'a> DataLibrary<'a, Box<Species>> for SpeciesLibrary {
 
 #[cfg(test)]
 pub mod tests {
+    use hashbrown::HashSet;
+
     use crate::static_data::libraries::data_library::DataLibrary;
     use crate::static_data::libraries::species_library::SpeciesLibrary;
-    use crate::static_data::species_data::form::Form;
-    use crate::static_data::species_data::learnable_moves::LearnableMoves;
-    use crate::static_data::species_data::species::Species;
+    use crate::static_data::Form;
+    use crate::static_data::LearnableMoves;
+    use crate::static_data::Species;
     use crate::static_data::StaticStatisticSet;
-    use hashbrown::HashSet;
 
     fn build_species() -> Species {
         Species::new(