Add basic description for all classes

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

diff --git a/source/geometry/rectangle.h b/source/geometry/rectangle.h
index dbebf8ab73d164f20367f37d2da476f39807e6db..cbf625c913a04be0cc894d3f7d9732dbfa0bdcb5 100644 (file)
--- a/source/geometry/rectangle.h
+++ b/source/geometry/rectangle.h
@@ -6,6 +6,11 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+The two-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 Rectangle: public HyperBox<T, 2>
 {