diff --git a/src/defines.rs b/src/defines.rs index c56c27a..fd5e2cf 100755 --- a/src/defines.rs +++ b/src/defines.rs @@ -1,6 +1,6 @@ /// The type we store a level in. As our implementation is aimed at normal Pokemon behaviour, a u8 -/// is probably enough, as we'd go up to 100. For other users this might however not be enough. This -/// allows them to easily change it. +/// is probably enough, as we'd go up to 100. If you for some reason want to go higher, you can just +/// change this type to hold a higher number. pub type LevelInt = u8; /// The amount of moves a Pokemon can have at once. This is set to 4, as that is the default in most diff --git a/src/dynamic_data/libraries/dynamic_library.rs b/src/dynamic_data/libraries/dynamic_library.rs index 149adc9..3fc0874 100755 --- a/src/dynamic_data/libraries/dynamic_library.rs +++ b/src/dynamic_data/libraries/dynamic_library.rs @@ -63,7 +63,7 @@ unsafe impl Send for DynamicLibraryImpl {} unsafe impl Sync for DynamicLibraryImpl {} impl DynamicLibraryImpl { - /// Instantiates a new DynamicLibrary with given parameters. + /// Instantiates a new DynamicLibrary with given libraries. pub fn new( static_data: Arc, stat_calculator: Arc, diff --git a/src/dynamic_data/models/pokemon.rs b/src/dynamic_data/models/pokemon.rs index 91b17a2..88c3467 100755 --- a/src/dynamic_data/models/pokemon.rs +++ b/src/dynamic_data/models/pokemon.rs @@ -415,11 +415,13 @@ impl Pokemon { Ok(changed) } - /// The [individual values](https://bulbapedia.bulbagarden.net/wiki/Individual_values) of the Pokemon. + /// Gets an individual value of the Pokemon. + /// [See also](https://bulbapedia.bulbagarden.net/wiki/Individual_values) pub fn individual_values(&self) -> &Arc> { &self.data.individual_values } - /// The [effort values](https://bulbapedia.bulbagarden.net/wiki/Effort_values) of the Pokemon. + /// Gets an effort value of the Pokemon. + /// [See also](https://bulbapedia.bulbagarden.net/wiki/Effort_values) pub fn effort_values(&self) -> &Arc> { &self.data.effort_values } @@ -485,7 +487,8 @@ impl Pokemon { self.data.allowed_experience } - /// The [nature](https://bulbapedia.bulbagarden.net/wiki/Nature) of the Pokemon. + /// The nature of the Pokemon. + /// [See also](https://bulbapedia.bulbagarden.net/wiki/Nature) pub fn nature(&self) -> &Arc { &self.data.nature } @@ -961,7 +964,7 @@ impl VolatileScriptsOwner for Pokemon { } } -/// A source of damage. This should be as unique as possible. +/// A source of damage. #[derive(Debug, Clone, Copy)] #[repr(u8)] pub enum DamageSource { diff --git a/src/ffi/dynamic_data/models/pokemon.rs b/src/ffi/dynamic_data/models/pokemon.rs index 464df65..54dd094 100644 --- a/src/ffi/dynamic_data/models/pokemon.rs +++ b/src/ffi/dynamic_data/models/pokemon.rs @@ -102,7 +102,8 @@ extern "C" fn pokemon_gender(handle: FFIHandle) -> Gender { handle.from_ffi_handle().gender() } -/// The coloring of the Pokemon. +/// The coloring of the Pokemon. If this is 1, the Pokemon is shiny, otherwise it is not. This can +/// also be used for other custom coloring schemes. #[no_mangle] extern "C" fn pokemon_coloring(handle: FFIHandle) -> u8 { handle.from_ffi_handle().coloring() @@ -196,13 +197,13 @@ extern "C" fn pokemon_nickname(handle: FFIHandle) -> FFIResult