Add basic description for all classes

[libs/math.git] / source / linal / squarematrix.h

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