feat: animation module docs

Author: alanpq

crates/league-toolkit/src/core/animation/asset/mod.rs

@@ -1,3 +1,4 @@
+//! Animation assets
 mod compressed;
 
 pub use compressed::*;
@@ -15,12 +16,15 @@ use error::AssetParseError::UnknownAssetType;
 use std::io;
 use std::io::{Read, Seek, SeekFrom};
 
+/// Encapsulates a .anm file
 #[derive(Clone, Debug)]
 pub enum AnimationAsset {
     Uncompressed(Uncompressed),
     Compressed(Compressed),
 }
 
+/// The type of animation asset
+#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 pub enum AnimationAssetType {
     Uncompressed,
     Compressed,
@@ -40,6 +44,7 @@ impl AnimationAsset {
         }
     }
 
+    /// Reads the animation magic (8 bytes), and identifies the animation asset type
     pub fn identify_from_reader<R: Read + ?Sized>(
         reader: &mut R,
     ) -> io::Result<AnimationAssetType> {

crates/league-toolkit/src/core/animation/rig/builder.rs

@@ -1,6 +1,7 @@
 use crate::core::animation::{joint, Joint, RigResource};
 use std::collections::VecDeque;
 
+/// Builder for [`RigResource`]
 pub struct Builder {
     name: String,
     asset_name: String,
@@ -15,11 +16,13 @@ impl Builder {
             root_joints: vec![],
         }
     }
+
     pub fn with_root_joint(mut self, child: joint::Builder) -> Self {
         self.add_root_joint(child);
         self
     }
 
+    /// Mutably add a root joint
     pub fn add_root_joint(&mut self, child: joint::Builder) {
         self.root_joints.push(child);
     }

crates/league-toolkit/src/core/animation/rig/mod.rs

@@ -1,10 +1,12 @@
+//! Read/write .skl
 mod builder;
 mod read;
 mod write;
 pub use builder::Builder;
 
 use super::Joint;
 
+/// Encapsulates a .skl file
 #[derive(Debug, Clone, PartialEq)]
 pub struct RigResource {
     flags: u16,