summaryrefslogtreecommitdiffstats
path: root/src/math/func.h
diff options
context:
space:
mode:
authorPiotr Dziwinski <piotrdz@gmail.com>2012-05-01 20:05:48 +0200
committerPiotr Dziwinski <piotrdz@gmail.com>2012-05-01 20:05:48 +0200
commit2513f6556e30e7d98ca615ed769ad82f902f7137 (patch)
tree135f4b437feba9e01bdb056e9fe4ecda9ff6d06e /src/math/func.h
parent7369b10a87aed982de328fbfa242666928e021d6 (diff)
downloadcolobot-2513f6556e30e7d98ca615ed769ad82f902f7137.tar.gz
colobot-2513f6556e30e7d98ca615ed769ad82f902f7137.tar.bz2
colobot-2513f6556e30e7d98ca615ed769ad82f902f7137.zip
Structs continued
Basic functions finished and tested for matrix and vector.
Diffstat (limited to 'src/math/func.h')
-rw-r--r--src/math/func.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/src/math/func.h b/src/math/func.h
index 8043329..8dcae99 100644
--- a/src/math/func.h
+++ b/src/math/func.h
@@ -14,9 +14,9 @@
// * You should have received a copy of the GNU General Public License
// * along with this program. If not, see http://www.gnu.org/licenses/.
-// math/func.h
-
-/* Common math functions */
+/** @defgroup MathFuncModule math/func.h
+ Contains common math functions.
+ */
#pragma once
@@ -26,9 +26,13 @@
#include <cmath>
#include <cstdlib>
+
+// Math module namespace
namespace Math
{
+/* @{ */ // start of group
+
//! Compares \a a and \a b within \a tolerance
inline bool IsEqual(float a, float b, float tolerance = Math::TOLERANCE)
{
@@ -254,5 +258,6 @@ inline float Bounce(float progress, float middle, float bounce)
}
}
-}; // namespace Math
+/* @} */ // end of group
+}; // namespace Math