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 296ba6c936c959dcb94bb0174b2a1457bd23b562..cbf625c913a04be0cc894d3f7d9732dbfa0bdcb5 100644 (file)
--- a/source/geometry/rectangle.h
+++ b/source/geometry/rectangle.h
@@ -1,19 +1,23 @@
 #ifndef MSP_GEOMETRY_RECTANGLE_H_
 #define MSP_GEOMETRY_RECTANGLE_H_
 
-#include <msp/linal/vector2.h>
 #include "hyperbox.h"
 
 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>
 {
 public:
        Rectangle() { }
        explicit Rectangle(const LinAl::Vector<T, 2> &d): HyperBox<T, 2>(d) { }
-       Rectangle(T w, T h): HyperBox<T, 2>(LinAl::Vector2<T>(w, h)) { }
+       Rectangle(T w, T h): HyperBox<T, 2>(LinAl::Vector<T, 2>(w, h)) { }
 
        T get_width() const { return this->get_dimension(0); }
        T get_height() const { return this->get_dimension(1); }