From 0b1004135890380d2594b4aff3bb2fb17d64b6c4 Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Mon, 28 Aug 2017 20:59:20 +0100
Subject: Adding more documentation and improving tests.

---
 docs/matrix.dox | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 docs/matrix.dox

(limited to 'docs/matrix.dox')

diff --git a/docs/matrix.dox b/docs/matrix.dox
new file mode 100644
index 00000000..c1c99dde
--- /dev/null
+++ b/docs/matrix.dox
@@ -0,0 +1,33 @@
+/** @class yage::Matrix
+
+%Matrix Class
+============
+
+The matrix class is a templated class which implements a mathematical %Matrix.
+
+
+Usage Guide
+-----------
+
+The class can be instantiated
+
+
+Example Code
+------------
+
+Creating a %Matrix and performing operations on it.
+
+```
+#include <YAGE/Math/matrix.hpp>
+
+int main(int, char **)
+{
+    yage::Matrix<2, 2, int> mat1 {{1, 2, 3, 4}};
+    yage::Matrix<2, 2, int> mat2 {{5, 6, 7, 8}};
+
+    int dot = yage::math::dot(mat1, mat2);
+    return 0;
+}
+```
+
+*/
-- 
cgit