Initial work on adding documentation, reorganises modules

src/dynamic_data/models/battle.rs

@@ -1,24 +1,26 @@
+use std::ops::{Deref, DerefMut};
+use std::sync::atomic::{AtomicBool, AtomicU32, Ordering};
+use std::sync::Arc;
+
+use atomic::Atomic;
+use parking_lot::RwLock;
+
 use crate::dynamic_data::choices::TurnChoice;
-use crate::dynamic_data::event_hooks::event_hook::{Event, EventHook};
-use crate::dynamic_data::flow::choice_queue::ChoiceQueue;
-use crate::dynamic_data::flow::target_resolver::is_valid_target;
-use crate::dynamic_data::history::history_holder::HistoryHolder;
-use crate::dynamic_data::libraries::dynamic_library::DynamicLibrary;
+use crate::dynamic_data::event_hooks::{Event, EventHook};
+use crate::dynamic_data::history::HistoryHolder;
+use crate::dynamic_data::is_valid_target;
 use crate::dynamic_data::models::battle_party::BattleParty;
 use crate::dynamic_data::models::battle_random::BattleRandom;
 use crate::dynamic_data::models::battle_result::BattleResult;
 use crate::dynamic_data::models::battle_side::BattleSide;
 use crate::dynamic_data::models::pokemon::Pokemon;
-use crate::dynamic_data::script_handling::script::Script;
-use crate::dynamic_data::script_handling::script_set::ScriptSet;
-use crate::dynamic_data::script_handling::volatile_scripts::VolatileScripts;
-use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
-use crate::{script_hook, PkmnResult, ScriptCategory, StringKey};
-use atomic::Atomic;
-use parking_lot::RwLock;
-use std::ops::{Deref, DerefMut};
-use std::sync::atomic::{AtomicBool, AtomicU32, Ordering};
-use std::sync::Arc;
+use crate::dynamic_data::ChoiceQueue;
+use crate::dynamic_data::DynamicLibrary;
+use crate::dynamic_data::Script;
+use crate::dynamic_data::ScriptSet;
+use crate::dynamic_data::VolatileScripts;
+use crate::dynamic_data::{ScriptCategory, ScriptSource, ScriptSourceData, ScriptWrapper};
+use crate::{script_hook, PkmnResult, StringKey};
 
 #[derive(Debug)]
 pub struct Battle<'own, 'library> {

src/dynamic_data/models/battle_random.rs

@@ -1,10 +1,11 @@
+use std::fmt::{Debug, Formatter};
+use std::sync::{Arc, Mutex};
+
 use crate::dynamic_data::models::executing_move::ExecutingMove;
 use crate::dynamic_data::models::pokemon::Pokemon;
 use crate::dynamic_data::script_handling::ScriptSource;
 use crate::script_hook;
-use crate::utils::random::Random;
-use std::fmt::{Debug, Formatter};
-use std::sync::{Arc, Mutex};
+use crate::utils::Random;
 
 #[derive(Default)]
 pub struct BattleRandom {

src/dynamic_data/models/battle_side.rs

@@ -1,19 +1,21 @@
-use crate::dynamic_data::choices::TurnChoice;
-use crate::dynamic_data::event_hooks::event_hook::Event;
-use crate::dynamic_data::models::battle::Battle;
-use crate::dynamic_data::models::battle_party::BattleParty;
-use crate::dynamic_data::models::pokemon::Pokemon;
-use crate::dynamic_data::script_handling::script::Script;
-use crate::dynamic_data::script_handling::script_set::ScriptSet;
-use crate::dynamic_data::script_handling::volatile_scripts::VolatileScripts;
-use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
-use crate::{script_hook, PkmnResult, StringKey};
-use parking_lot::lock_api::RwLockReadGuard;
-use parking_lot::{RawRwLock, RwLock};
 use std::ops::Deref;
 use std::sync::atomic::{AtomicBool, AtomicU8, Ordering};
 use std::sync::Arc;
 
+use parking_lot::lock_api::RwLockReadGuard;
+use parking_lot::{RawRwLock, RwLock};
+
+use crate::dynamic_data::choices::TurnChoice;
+use crate::dynamic_data::event_hooks::Event;
+use crate::dynamic_data::models::battle::Battle;
+use crate::dynamic_data::models::battle_party::BattleParty;
+use crate::dynamic_data::models::pokemon::Pokemon;
+use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
+use crate::dynamic_data::Script;
+use crate::dynamic_data::ScriptSet;
+use crate::dynamic_data::VolatileScripts;
+use crate::{script_hook, PkmnResult, StringKey};
+
 #[derive(Debug)]
 pub struct BattleSide<'own, 'library> {
     index: u8,

src/dynamic_data/models/executing_move.rs

@@ -1,16 +1,18 @@
-use crate::dynamic_data::flow::target_resolver::TargetList;
-use crate::dynamic_data::models::learned_move::LearnedMove;
-use crate::dynamic_data::models::pokemon::Pokemon;
-use crate::dynamic_data::script_handling::script::ScriptContainer;
-use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
-use crate::static_data::MoveData;
-use crate::{PkmnResult, PokemonError};
-use atomic::Atomic;
-use parking_lot::RwLock;
 use std::ops::Deref;
 use std::sync::atomic::{AtomicBool, AtomicU32, AtomicU8, Ordering};
 use std::sync::Arc;
 
+use atomic::Atomic;
+use parking_lot::RwLock;
+
+use crate::dynamic_data::models::learned_move::LearnedMove;
+use crate::dynamic_data::models::pokemon::Pokemon;
+use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
+use crate::dynamic_data::ScriptContainer;
+use crate::dynamic_data::TargetList;
+use crate::static_data::MoveData;
+use crate::{PkmnResult, PokemonError};
+
 #[derive(Default, Debug)]
 pub struct HitData {
     critical: AtomicBool,

src/dynamic_data/models/mod.rs

@@ -1,11 +1,34 @@
-pub mod battle;
-pub mod battle_party;
-pub mod battle_random;
-pub mod battle_result;
-pub mod battle_side;
-pub mod damage_source;
-pub mod executing_move;
-pub mod learned_move;
-pub mod pokemon;
-pub mod pokemon_builder;
-pub mod pokemon_party;
+#[doc(inline)]
+pub use battle::*;
+#[doc(inline)]
+pub use battle_party::*;
+#[doc(inline)]
+pub use battle_random::*;
+#[doc(inline)]
+pub use battle_result::*;
+#[doc(inline)]
+pub use battle_side::*;
+#[doc(inline)]
+pub use damage_source::*;
+#[doc(inline)]
+pub use executing_move::*;
+#[doc(inline)]
+pub use learned_move::*;
+#[doc(inline)]
+pub use pokemon::*;
+#[doc(inline)]
+pub use pokemon_builder::*;
+#[doc(inline)]
+pub use pokemon_party::*;
+
+mod battle;
+mod battle_party;
+mod battle_random;
+mod battle_result;
+mod battle_side;
+mod damage_source;
+mod executing_move;
+mod learned_move;
+mod pokemon;
+mod pokemon_builder;
+mod pokemon_party;

src/dynamic_data/models/pokemon.rs

@@ -1,30 +1,29 @@
-use crate::defines::{LevelInt, MAX_MOVES};
-use crate::dynamic_data::event_hooks::event_hook::Event;
-use crate::dynamic_data::libraries::dynamic_library::DynamicLibrary;
-use crate::dynamic_data::models::battle::Battle;
-use crate::dynamic_data::models::damage_source::DamageSource;
-use crate::dynamic_data::models::learned_move::{LearnedMove, MoveLearnMethod};
-use crate::dynamic_data::script_handling::script::{Script, ScriptContainer};
-use crate::dynamic_data::script_handling::script_set::ScriptSet;
-use crate::dynamic_data::script_handling::volatile_scripts::VolatileScripts;
-use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
-use crate::static_data::items::item::Item;
-use crate::static_data::natures::Nature;
-use crate::static_data::species_data::ability::Ability;
-use crate::static_data::species_data::ability_index::AbilityIndex;
-use crate::static_data::species_data::form::Form;
-use crate::static_data::species_data::gender::Gender;
-use crate::static_data::species_data::species::Species;
-use crate::static_data::statistic_set::{ClampedStatisticSet, StatisticSet};
-use crate::static_data::DataLibrary;
-use crate::utils::random::Random;
-use crate::{script_hook, PkmnResult, ScriptCategory, StringKey};
-use atomic::Atomic;
-use parking_lot::RwLock;
 use std::ops::{Deref, DerefMut};
 use std::sync::atomic::{AtomicBool, AtomicI8, AtomicU32, AtomicU8, Ordering};
 use std::sync::{Arc, Weak};
 
+use atomic::Atomic;
+use parking_lot::RwLock;
+
+use crate::defines::{LevelInt, MAX_MOVES};
+use crate::dynamic_data::event_hooks::Event;
+use crate::dynamic_data::models::battle::Battle;
+use crate::dynamic_data::models::damage_source::DamageSource;
+use crate::dynamic_data::models::learned_move::{LearnedMove, MoveLearnMethod};
+use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, ScriptWrapper};
+use crate::dynamic_data::{DynamicLibrary, Script, ScriptCategory, ScriptContainer, ScriptSet, VolatileScripts};
+use crate::static_data::Ability;
+use crate::static_data::AbilityIndex;
+use crate::static_data::DataLibrary;
+use crate::static_data::Form;
+use crate::static_data::Gender;
+use crate::static_data::Item;
+use crate::static_data::Nature;
+use crate::static_data::Species;
+use crate::static_data::{ClampedStatisticSet, StatisticSet};
+use crate::utils::Random;
+use crate::{script_hook, PkmnResult, StringKey};
+
 #[derive(Debug)]
 pub struct PokemonBattleData<'pokemon, 'library> {
     battle: *mut Battle<'pokemon, 'library>,
@@ -585,15 +584,15 @@ impl<'own, 'library> VolatileScripts<'own> for Pokemon<'own, 'library> {
 
 #[cfg(test)]
 pub mod test {
-    use crate::dynamic_data::libraries::dynamic_library;
     use crate::dynamic_data::models::pokemon::Pokemon;
-    use crate::static_data::libraries::data_library::DataLibrary;
-    use crate::static_data::species_data::ability_index::AbilityIndex;
-    use crate::static_data::species_data::gender::Gender;
+    use crate::dynamic_data::DynamicLibrary;
+    use crate::static_data::AbilityIndex;
+    use crate::static_data::DataLibrary;
+    use crate::static_data::Gender;
 
     #[test]
     fn construct_pokemon() {
-        let lib = dynamic_library::test::build();
+        let lib = crate::dynamic_data::libraries::dynamic_library::test::build();
         let species = lib.static_data().species().get(&"foo".into()).unwrap();
         let form = species.get_form(&"default".into()).unwrap();
 

src/dynamic_data/models/pokemon_builder.rs

@@ -1,7 +1,7 @@
 use crate::defines::LevelInt;
-use crate::dynamic_data::libraries::dynamic_library::DynamicLibrary;
 use crate::dynamic_data::models::learned_move::MoveLearnMethod;
 use crate::dynamic_data::models::pokemon::Pokemon;
+use crate::dynamic_data::DynamicLibrary;
 use crate::static_data::{AbilityIndex, DataLibrary, Gender};
 use crate::StringKey;