From de649c3b50f5fb8e546b4bdd99f03e45797e5a8e Mon Sep 17 00:00:00 2001 From: Brendan Zabarauskas Date: Thu, 11 Jul 2013 14:59:18 +1000 Subject: [PATCH] Add a bit of documentation to the point module --- src/geom/point.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/geom/point.rs b/src/geom/point.rs index 41d595d..940509c 100644 --- a/src/geom/point.rs +++ b/src/geom/point.rs @@ -13,6 +13,13 @@ // See the License for the specific language governing permissions and // limitations under the License. +//! Coordinate vectors for positional data +//! +//! These types differ from the vector types implemented in `core::vec` because +//! they describe coordinates in geometric space and not a magnitude and a +//! direction. All positional data throughout the library uses these point +//! types, which allows for a clear, self-documenting API. + use std::cast; use core::{Mat2, Mat3, Quat, Vec2, Vec3};