aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-08-21 20:55:02 +0100
committerYann Herklotz <ymherklotz@gmail.com>2017-08-21 20:55:02 +0100
commit4b95a1ac4265e2f51bf78969ce259f0f8b91fd91 (patch)
treec5778607fe4efef42296a535f890021aa2958699 /include
parent6a8bc8a624e2c7777d57c3363dfe8c8dadeff84f (diff)
downloadYAGE-4b95a1ac4265e2f51bf78969ce259f0f8b91fd91.tar.gz
YAGE-4b95a1ac4265e2f51bf78969ce259f0f8b91fd91.zip
Adding documentation to matrix class
Diffstat (limited to 'include')
-rw-r--r--include/YAGE/Math/matrix.hpp9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/YAGE/Math/matrix.hpp b/include/YAGE/Math/matrix.hpp
index 860a250c..52536c17 100644
--- a/include/YAGE/Math/matrix.hpp
+++ b/include/YAGE/Math/matrix.hpp
@@ -121,14 +121,15 @@ public:
return colMatrix;
}
- // iterator support for begin
+ /// iterator support for begin
typename std::vector<Type>::iterator begin() { return data_.begin(); }
- // iterator support for end
+ /// iterator support for end
typename std::vector<Type>::iterator end() { return data_.end(); }
- // prints out the matrix, but can also be implemented by other classes to
- // print data differently
+ /** prints out the matrix, but can also be implemented by other classes to
+ * print data differently
+ */
virtual std::string toString() const {
std::stringstream ss;
ss << '[';