Finished documenting all public interfaces.

src/static_data/species_data/ability.rs

@@ -1,14 +1,19 @@
 use crate::static_data::EffectParameter;
 use crate::StringKey;
 
+/// An ability is a passive effect in battle that is attached to a Pokemon.
 #[derive(Debug)]
 pub struct Ability {
+    /// The name of the ability.
     name: StringKey,
+    /// The name of the script effect of the ability.
     effect: StringKey,
+    /// The parameters for the script effect of the ability.
     parameters: Vec<EffectParameter>,
 }
 
 impl Ability {
+    /// Instantiates a new ability.
     pub fn new(name: &StringKey, effect: &StringKey, parameters: Vec<EffectParameter>) -> Self {
         Self {
             name: name.clone(),
@@ -17,12 +22,15 @@ impl Ability {
         }
     }
 
+    /// The name of the ability.
     pub fn name(&self) -> &StringKey {
         &self.name
     }
+    /// The name of the script effect of the ability.
     pub fn effect(&self) -> &StringKey {
         &self.effect
     }
+    /// The parameters for the script effect of the ability.
     pub fn parameters(&self) -> &Vec<EffectParameter> {
         &self.parameters
     }