aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-07-28 00:41:40 +0100
committerYann Herklotz <ymherklotz@gmail.com>2017-07-28 00:41:40 +0100
commit9aba276757243c426d5e18536779f1bf277b4c91 (patch)
tree1bfb5756c82b8e980ee4c031be1a94770d7910e6 /include
parentdf6b5072ebd36dbc488eb610877e7a50441df388 (diff)
downloadYAGE-9aba276757243c426d5e18536779f1bf277b4c91.tar.gz
YAGE-9aba276757243c426d5e18536779f1bf277b4c91.zip
Adding update_docs script and updated documentation
Diffstat (limited to 'include')
-rw-r--r--include/YAGE/Math/matrix.hpp37
1 files changed, 28 insertions, 9 deletions
diff --git a/include/YAGE/Math/matrix.hpp b/include/YAGE/Math/matrix.hpp
index 42f5ebbc..87347f60 100644
--- a/include/YAGE/Math/matrix.hpp
+++ b/include/YAGE/Math/matrix.hpp
@@ -6,6 +6,17 @@
* ----------------------------------------------------------------------------
*/
+/** \file matrix.hpp
+ * \brief Templated matrix class
+ *
+ * Matrix
+ * ======
+
+ * This is a very general matrix class that can then be inherited by
+ * vectors and other similar data structures to minimize code
+ * density.
+ */
+
#ifndef YAGE_MATH_MATRIX_HPP
#define YAGE_MATH_MATRIX_HPP
@@ -21,14 +32,17 @@ namespace yage
template<int Rows, int Cols, class Type> class Matrix;
-// includes implementation details that should not be accessible to the user
+/** \namespace detail
+ * \brief Detail namespace
+ *
+ * Detail Namespace
+ * ================
+ *
+ * This is the namespace used for implementation detail.
+ */
namespace detail
{
-// Row class
-//
-// Used to implement the double square bracket operator and be able
-// to return the value by reference of the array.
template<int Rows, int Cols, class Type> class Row
{
private:
@@ -54,10 +68,15 @@ public:
} // detail
-// Matrix class
-//
-// Implements the base Matrix class that is inherited by other classes to make them more
-// specific.
+/** \class Matrix
+ * \brief Base matrix class
+ *
+ * Matrix class
+ * ============
+ *
+ * This is the base matrix class that can be used by all the other matrix
+ * like data structures.
+ */
template<int Rows=4, int Cols=4, class Type=double> class Matrix
{
// friended with the row class so that it can access protected member data