Add mods docs

src/animation.rs

@@ -1,3 +1,7 @@
+//!
+//!
+//!
+
 use glam::{Quat, Vec3, Vec4};
 use std::io::Read;
 use std::mem;

src/archive.rs

@@ -1,3 +1,7 @@
+//!
+//! Animation data structure definition.
+//!
+
 use glam::{Quat, Vec2, Vec3, Vec4};
 #[cfg(not(feature = "wasm"))]
 use std::fs::File;

src/blending_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Blending job.
+//!
+
 use glam::Vec4;
 use std::cell::RefCell;
 use std::rc::Rc;

src/ik_aim_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Aim IK Job.
+//!
+
 use glam::{Mat4, Quat, Vec3A};
 use std::simd::prelude::*;
 use std::simd::StdFloat;

src/ik_two_bone_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Two bone IK job.
+//!
+
 use glam::{Mat4, Quat, Vec3A};
 use std::simd::prelude::*;
 use std::simd::StdFloat;

src/local_to_model_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Local to Model Job.
+//!
+
 use glam::Mat4;
 use std::cell::RefCell;
 use std::rc::Rc;

src/sampling_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Sampling Job.
+//!
+
 use std::alloc::{self, Layout};
 use std::cell::RefCell;
 use std::fmt::{Debug, Formatter};

src/skeleton.rs

@@ -1,3 +1,7 @@
+//!
+//! Skeleton data structure definition.
+//!
+
 use bimap::BiHashMap;
 use std::io::Read;
 

src/skinning_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Skinning Job.
+//!
+
 use glam::{Mat4, Vec3, Vec4};
 use std::cell::RefCell;
 use std::fmt::Debug;
@@ -6,6 +10,9 @@ use std::sync::{Arc, RwLock};
 
 use crate::base::{OzzBuf, OzzError, OzzMutBuf};
 
+/// Skinning job.
+///
+/// TODO: Deterministic tests.
 #[derive(Debug)]
 pub struct SkinningJob<
     JM = Rc<RefCell<Vec<Mat4>>>,

src/track.rs

@@ -1,3 +1,7 @@
+//!
+//! Track data structure definition.
+//!
+
 use glam::{Quat, Vec2, Vec3, Vec4};
 use std::fmt::Debug;
 use std::io::Read;

src/track_sampling_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Track sampling job.
+//!
+
 use std::fmt::Debug;
 use std::rc::Rc;
 use std::sync::Arc;

src/track_triggering_job.rs

@@ -1,3 +1,7 @@
+//!
+//! Track Triggering Job.
+//!
+
 use std::fmt::Debug;
 use std::rc::Rc;
 use std::sync::Arc;