Add basic description for all classes

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

diff --git a/source/geometry/hyperbox.h b/source/geometry/hyperbox.h
index 6248d6b0920e906f5bad1ee1ce1b9ba6fbb97fc4..7d363f246a8a48e25cbb07762e351f7f4dc58936 100644 (file)
--- a/source/geometry/hyperbox.h
+++ b/source/geometry/hyperbox.h
@@ -11,6 +11,10 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+A shape bounded by planar faces at right angles to each other.  Two- and three-
+dimensional cases are Rectangle and Box, respectively.
+*/
 template<typename T, unsigned D>
 class HyperBox: public Shape<T, D>
 {