Add basic description for all classes

[libs/math.git] / source / geometry / box.h

diff --git a/source/geometry/box.h b/source/geometry/box.h
index 40f88dc4412bb805159fd72197f9c6406a43106b..b46eb677c37b7f0c0180505facdfe219f8d22e81 100644 (file)
--- a/source/geometry/box.h
+++ b/source/geometry/box.h
@@ -6,6 +6,11 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+The three-dimensional special case of a HyperBox.  This class exists for
+convenience only and does not provide any extra functionality over the base
+class.
+*/
 template<typename T>
 class Box: public HyperBox<T, 3>
 {