Add basic description for all classes

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>
 {

diff --git a/source/geometry/circle.h b/source/geometry/circle.h
index ebc1c41b2501347852c94653f83c666dd5711772..3a2cfc286dc82049117ab324dddd2fe52f5097e7 100644 (file)
--- a/source/geometry/circle.h
+++ b/source/geometry/circle.h
@@ -6,6 +6,11 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+The two-dimensional special case of a HyperSphere.  This class exists for
+convenience only and does not provide any extra functionality over the base
+class.
+*/
 template<typename T>
 class Circle: public HyperSphere<T, 2>
 {

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>
 {

diff --git a/source/geometry/hypersphere.h b/source/geometry/hypersphere.h
index f95ebe4182094667533e2cec0914210cb7b79337..ed2b49ff161141e4364a5bd81773ed0c9cc16632 100644 (file)
--- a/source/geometry/hypersphere.h
+++ b/source/geometry/hypersphere.h
@@ -10,6 +10,10 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+A shape consisting of the points within a specific distance from the origin.
+Two- and three-dimensional cases are Circle and Sphere, respectively.
+*/
 template<typename T, unsigned D>
 class HyperSphere: public Shape<T, D>
 {

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>
 {

diff --git a/source/geometry/shape.h b/source/geometry/shape.h
index 1f8176418a4e9a948b460701e6e682d56ae31771..3f52613bef98d9df47e3c935fd4ddca213e98b82 100644 (file)
--- a/source/geometry/shape.h
+++ b/source/geometry/shape.h
@@ -16,6 +16,11 @@ class Ray;
 template<typename T, unsigned D>
 class SurfacePoint;
 
+/**
+Base class and interface for geometric shapes.  Shapes may be bounded or
+unbounded.  They are always considered to be solid, i.e. have a distinct inside
+and an outside.
+*/
 template<typename T, unsigned D>
 class Shape
 {

diff --git a/source/geometry/surfacepoint.h b/source/geometry/surfacepoint.h
index 3513ac8e41bf82e1a02e3250ccdfaebb57932576..251964cef854d91469f6ed9c10280534d3519535 100644 (file)
--- a/source/geometry/surfacepoint.h
+++ b/source/geometry/surfacepoint.h
@@ -6,6 +6,9 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+A point on the surface of a shape.
+*/
 template<typename T, unsigned N>
 struct SurfacePoint
 {

diff --git a/source/geometry/transformedshape.h b/source/geometry/transformedshape.h
index ea7281f746067c8d0c4dcb757edd1120ee0c903b..01253680f6340a9ed277f76664b906313f8314e2 100644 (file)
--- a/source/geometry/transformedshape.h
+++ b/source/geometry/transformedshape.h
@@ -8,6 +8,9 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+A shape modified by an affine transformation.
+*/
 template<typename T, unsigned D>
 class TransformedShape: public Shape<T, D>
 {

diff --git a/source/linal/matrix.h b/source/linal/matrix.h
index 6c04454296e51ae2162e0534f1def87fa379afac..599c1dc604a35517f82a9cead6c9ae25e79fb140 100644 (file)
--- a/source/linal/matrix.h
+++ b/source/linal/matrix.h
@@ -8,7 +8,7 @@ namespace Msp {
 namespace LinAl {
 
 /**
-A general mathematical matrix.
+A general mathematical matrix with M rows and N columns.
 */
 template<typename T, unsigned M, unsigned N>
 class Matrix

diff --git a/source/linal/squarematrix.h b/source/linal/squarematrix.h
index ee86e13921219702fa58a682c4b5ab2bb5cfb290..0af9a7454852cb5106382fcda2a4f1c5e2aaf824 100644 (file)
--- a/source/linal/squarematrix.h
+++ b/source/linal/squarematrix.h
@@ -14,6 +14,10 @@ public:
        virtual ~not_invertible() throw() { }
 };
 
+/**
+A mathematical matrix with S rows and columns.  Some operations are provided
+here that are only possible for square matrices.
+*/
 template<typename T, unsigned S>
 class SquareMatrix: public Matrix<T, S, S>
 {