From bbaadd58c3d887f1cea931da850088381ba8ddc4 Mon Sep 17 00:00:00 2001 From: Nan Date: Mon, 6 May 2024 21:54:17 +0800 Subject: [PATCH] Add mods docs --- src/animation.rs | 4 ++++ src/archive.rs | 4 ++++ src/blending_job.rs | 4 ++++ src/ik_aim_job.rs | 4 ++++ src/ik_two_bone_job.rs | 4 ++++ src/local_to_model_job.rs | 4 ++++ src/sampling_job.rs | 4 ++++ src/skeleton.rs | 4 ++++ src/skinning_job.rs | 7 +++++++ src/track.rs | 4 ++++ src/track_sampling_job.rs | 4 ++++ src/track_triggering_job.rs | 4 ++++ 12 files changed, 51 insertions(+) diff --git a/src/animation.rs b/src/animation.rs index 3612eac..55f817f 100644 --- a/src/animation.rs +++ b/src/animation.rs @@ -1,3 +1,7 @@ +//! +//! +//! + use glam::{Quat, Vec3, Vec4}; use std::io::Read; use std::mem; diff --git a/src/archive.rs b/src/archive.rs index 477816e..d43d3a5 100644 --- a/src/archive.rs +++ b/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; diff --git a/src/blending_job.rs b/src/blending_job.rs index c0b69bb..b568115 100644 --- a/src/blending_job.rs +++ b/src/blending_job.rs @@ -1,3 +1,7 @@ +//! +//! Blending job. +//! + use glam::Vec4; use std::cell::RefCell; use std::rc::Rc; diff --git a/src/ik_aim_job.rs b/src/ik_aim_job.rs index 114d2bb..aa18db9 100644 --- a/src/ik_aim_job.rs +++ b/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; diff --git a/src/ik_two_bone_job.rs b/src/ik_two_bone_job.rs index 557ab7c..d9ab17d 100644 --- a/src/ik_two_bone_job.rs +++ b/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; diff --git a/src/local_to_model_job.rs b/src/local_to_model_job.rs index 4b17d8c..445adc9 100644 --- a/src/local_to_model_job.rs +++ b/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; diff --git a/src/sampling_job.rs b/src/sampling_job.rs index d3817ca..bd93fed 100644 --- a/src/sampling_job.rs +++ b/src/sampling_job.rs @@ -1,3 +1,7 @@ +//! +//! Sampling Job. +//! + use std::alloc::{self, Layout}; use std::cell::RefCell; use std::fmt::{Debug, Formatter}; diff --git a/src/skeleton.rs b/src/skeleton.rs index 3a0c66d..b153d2a 100644 --- a/src/skeleton.rs +++ b/src/skeleton.rs @@ -1,3 +1,7 @@ +//! +//! Skeleton data structure definition. +//! + use bimap::BiHashMap; use std::io::Read; diff --git a/src/skinning_job.rs b/src/skinning_job.rs index 4f5475a..e0689d1 100644 --- a/src/skinning_job.rs +++ b/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>>, diff --git a/src/track.rs b/src/track.rs index 11ef53b..43d36c7 100644 --- a/src/track.rs +++ b/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; diff --git a/src/track_sampling_job.rs b/src/track_sampling_job.rs index 7e5f7b3..0143c98 100644 --- a/src/track_sampling_job.rs +++ b/src/track_sampling_job.rs @@ -1,3 +1,7 @@ +//! +//! Track sampling job. +//! + use std::fmt::Debug; use std::rc::Rc; use std::sync::Arc; diff --git a/src/track_triggering_job.rs b/src/track_triggering_job.rs index f1ce0fc..a8f8080 100644 --- a/src/track_triggering_job.rs +++ b/src/track_triggering_job.rs @@ -1,3 +1,7 @@ +//! +//! Track Triggering Job. +//! + use std::fmt::Debug; use std::rc::Rc; use std::sync::Arc;