Merge pull request #83 from SlimeYummy/feat/docs

Add more docs

src/animation.rs

@@ -1,5 +1,5 @@
 //!
-//!
+//! Animation data structure definition.
 //!
 
 use glam::{Quat, Vec3, Vec4};
@@ -12,6 +12,7 @@ use crate::archive::{Archive, ArchiveRead};
 use crate::base::OzzError;
 use crate::math::{f16_to_f32, fx4, ix4, simd_f16_to_f32, SoaQuat, SoaVec3};
 
+/// Float3 key for `Animation` track.
 #[repr(C)]
 #[derive(Debug, Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "rkyv", derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize))]
@@ -51,6 +52,7 @@ impl ArchiveRead<Float3Key> for Float3Key {
     }
 }
 
+/// Quaternion key for `Animation` track.
 #[repr(C)]
 #[derive(Debug, Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "rkyv", derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize))]

src/blending_job.rs

@@ -66,6 +66,7 @@ impl<I: OzzBuf<SoaTransform>> BlendingLayer<I> {
     }
 }
 
+/// Blending context for storing intermediate blending data in `BlendingJob`.
 #[derive(Debug, Clone)]
 pub struct BlendingContext {
     num_passes: u32,

src/math.rs

@@ -40,6 +40,7 @@ const SIGN_W: i32x4 = i32x4::from_array([0, 0, 0, core::i32::MIN]);
 // SoaVec3
 //
 
+/// Structure of Arrays (SoA) for Vec3.
 #[repr(C)]
 #[derive(Debug, Default, Clone, Copy, PartialEq)]
 pub struct SoaVec3 {
@@ -236,6 +237,7 @@ const _: () = {
 // SoaQuat
 //
 
+/// Structure of Arrays (SoA) for Quaternions.
 #[repr(C)]
 #[derive(Debug, Default, Clone, Copy, PartialEq)]
 pub struct SoaQuat {
@@ -469,6 +471,7 @@ const _: () = {
 // SoaTransform
 //
 
+/// Structure of Arrays (SoA) for Transformations.
 #[repr(C)]
 #[derive(Debug, Default, Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
@@ -758,6 +761,8 @@ impl AosMat4 {
 //
 // SoaMat4
 //
+
+/// Structure of Arrays (SoA) for 4x4 Matrices.
 #[repr(C)]
 #[derive(Debug, Default, Clone, Copy, PartialEq)]
 pub struct SoaMat4 {

src/track_triggering_job.rs

@@ -173,6 +173,7 @@ where
     }
 }
 
+/// Iterator of `Edge` that represents the detected edges.
 #[derive(Debug)]
 pub struct TrackTriggeringIter<'t, T>
 where