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 bfcfa2f6e02dc343461375f64713563b57750020..b46eb677c37b7f0c0180505facdfe219f8d22e81 100644 (file)
--- a/source/geometry/box.h
+++ b/source/geometry/box.h
@@ -1,19 +1,23 @@
 #ifndef MSP_GEOMETRY_BOX_H_
 #define MSP_GEOMETRY_BOX_H_
 
-#include <msp/linal/vector3.h>
 #include "hyperbox.h"
 
 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>
 {
 public:
        Box() { }
        explicit Box(const LinAl::Vector<T, 3> &d): HyperBox<T, 3>(d) { }
-       Box(T w, T h, T d): HyperBox<T, 3>(LinAl::Vector3<T>(w, h, d)) { }
+       Box(T w, T h, T d): HyperBox<T, 3>(LinAl::Vector<T, 3>(w, h, d)) { }
 
        T get_width() const { return this->get_dimension(0); }
        T get_height() const { return this->get_dimension(1); }