From 1277975708128a073f966242e90f72962b55ec9c Mon Sep 17 00:00:00 2001
From: Danny Robson <danny@nerdcruft.net>
Date: Thu, 24 Aug 2017 17:27:46 +1000
Subject: [PATCH] geom/aabb: add brief class description

---
 geom/aabb.hpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/geom/aabb.hpp b/geom/aabb.hpp
index 31ca00ce..a471136c 100644
--- a/geom/aabb.hpp
+++ b/geom/aabb.hpp
@@ -25,6 +25,10 @@
 
 namespace util::geom {
     ///////////////////////////////////////////////////////////////////////////
+    /// represents an axis-aligned bounding-box through two opposing corners.
+    ///
+    /// p0 must be less-than-or-equal to p1. equality is allowed so that we
+    /// can represent zero sized bounding-boxes.
     template <size_t S, typename T>
     struct aabb {
         aabb () = default;