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/scene/mod.rs | 3 +++ src/scene/shapes/sphere.rs | 3 +++ 2 files changed, 6 insertions(+) (limited to 'src/scene') diff --git a/src/scene/mod.rs b/src/scene/mod.rs index 13c5e23..7c77412 100644 --- a/src/scene/mod.rs +++ b/src/scene/mod.rs @@ -1,3 +1,6 @@ +//! Defines the scene type which contains all the objects in the scene. +//! +//! Also handles finding intersections between rays and shapes pub mod shapes; mod scene; diff --git a/src/scene/shapes/sphere.rs b/src/scene/shapes/sphere.rs index f8ae11e..e30c1ec 100644 --- a/src/scene/shapes/sphere.rs +++ b/src/scene/shapes/sphere.rs @@ -1,3 +1,6 @@ +//! Implements sphere +//! +//! Spheres are relatively easy to calculate intersections between use crate::Float; use crate::core::{Ray, Vector3f}; use super::Shape; -- cgit v1.2.3