From 94ab40413a27fb4ed238be7496b04a1ed33bb9f0 Mon Sep 17 00:00:00 2001
From: Antoine Martin <antoine97.martin@gmail.com>
Date: Sun, 22 Mar 2020 00:29:24 +0100
Subject: [PATCH] library: document serialize module

---
 src/serialize/coefficient.rs | 3 +++
 src/serialize/mod.rs         | 2 ++
 src/serialize/vector.rs      | 5 +++++
 3 files changed, 10 insertions(+)

diff --git a/src/serialize/coefficient.rs b/src/serialize/coefficient.rs
index 1b37875..229871a 100644
--- a/src/serialize/coefficient.rs
+++ b/src/serialize/coefficient.rs
@@ -1,3 +1,6 @@
+//! Helper functions deserialize coefficients.
+
+/// Returns the identity for a f32, i.e. 1.0.
 pub fn default_identity() -> f32 {
     1.
 }
diff --git a/src/serialize/mod.rs b/src/serialize/mod.rs
index 1b8a1b0..9b6b8e4 100644
--- a/src/serialize/mod.rs
+++ b/src/serialize/mod.rs
@@ -1,3 +1,5 @@
+//! Helper functions to help scene (de)serialization
+
 pub mod vector;
 pub use vector::*;
 
diff --git a/src/serialize/vector.rs b/src/serialize/vector.rs
index 3a354bf..00d40ab 100644
--- a/src/serialize/vector.rs
+++ b/src/serialize/vector.rs
@@ -1,6 +1,11 @@
+//! Helper functions to deserialize `Vector` values.
+
 use crate::Vector;
 use serde::de::{Deserialize, Deserializer};
 
+/// Deserialize a vector.
+///
+/// Needs a custom implementation to make sur the vector is normalized when deserialized.
 pub fn vector_normalizer<'de, D>(deserializer: D) -> Result<Vector, D::Error>
 where
     D: Deserializer<'de>,