aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/YAGE/Math/matrix.hpp4
-rw-r--r--include/YAGE/yage.hpp21
2 files changed, 23 insertions, 2 deletions
diff --git a/include/YAGE/Math/matrix.hpp b/include/YAGE/Math/matrix.hpp
index 78cb4008..fc81fa34 100644
--- a/include/YAGE/Math/matrix.hpp
+++ b/include/YAGE/Math/matrix.hpp
@@ -112,7 +112,7 @@ public:
return rowMatrix;
}
- /** Get a specific column in a column vector.
+ /** Get a specific column in a column vector.
*
* @param col Column number to be returned.
* @return Column Matrix of the selected column.
@@ -409,7 +409,7 @@ Matrix<M, Q, T> multiply(const Matrix<M, N, T> &m1, const Matrix<P, Q, T> &m2)
throw std::runtime_error(
"Matrices don't have the right dimensions for multiplication");
}
-
+
Matrix<M, Q, T> res;
/// Performs multiplication by getting the rows and columns, transposing
diff --git a/include/YAGE/yage.hpp b/include/YAGE/yage.hpp
index f7b32683..13d6d560 100644
--- a/include/YAGE/yage.hpp
+++ b/include/YAGE/yage.hpp
@@ -6,6 +6,11 @@
* ----------------------------------------------------------------------------
*/
+/** @file Includes all the headers in the main YAGE project.
+ *
+ * This does not include
+ */
+
#ifndef YAGE_HPP
#define YAGE_HPP
@@ -25,13 +30,29 @@
#include <stdexcept>
+/** Project namespace.
+ *
+ * Avoids collision as all the classes and global functions are wrapped in.
+ * it.
+ */
namespace yage
{
+/** Initializes YAGE.
+ *
+ * This is only there to initialize SDL2.
+ *
+ * @return Returns true if the initialization was successful.
+ */
bool init()
{
return SDL_Init(SDL_INIT_VIDEO);
}
+
+/** Quit and cleanup YAGE
+ *
+ * SDL2 needs to clean itself up.
+ */
void quit()
{
SDL_Quit();