From 2b4adacea3c76b8b33dc5f50d296dd4a61107c16 Mon Sep 17 00:00:00 2001 From: Julian T Date: Tue, 2 Feb 2021 20:39:32 +0100 Subject: Added documentation for many of the modules --- src/lib.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 05fbff3..df9bc1d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,6 +5,9 @@ mod scene; use std::ops::{Add, Sub, Mul, DivAssign}; use std::cmp; +/// Trait used to implement generics +/// +/// This is used in Bound and Vectors pub trait Number: Copy + cmp::PartialOrd + @@ -14,9 +17,10 @@ pub trait Number: DivAssign {} -impl Number for usize {} impl Number for i32 {} impl Number for f32 {} -// Used throughout the program -type Float = f32; +/// Used for representing floating point values throughout the program +/// +/// A higher precision type will require more ram +pub type Float = f32; -- cgit v1.2.3