From d72784fa0240255b7c6d39180ed9f01f8f4ebc4b Mon Sep 17 00:00:00 2001 From: anulax1225 Date: Thu, 25 Jan 2024 15:03:36 +0100 Subject: [PATCH] Added documentation to math folder --- bakara/src/bakara/math/mathpch.h | 4 ++++ bakara/src/bakara/math/type.h | 30 ++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/bakara/src/bakara/math/mathpch.h b/bakara/src/bakara/math/mathpch.h index 63405f1..5982144 100644 --- a/bakara/src/bakara/math/mathpch.h +++ b/bakara/src/bakara/math/mathpch.h @@ -1,4 +1,8 @@ #pragma once +/*! \file mathpch.h +Precompiled headers communly used in math functionnalitys. +*/ + #include #include \ No newline at end of file diff --git a/bakara/src/bakara/math/type.h b/bakara/src/bakara/math/type.h index c87174d..849e905 100644 --- a/bakara/src/bakara/math/type.h +++ b/bakara/src/bakara/math/type.h @@ -1,4 +1,34 @@ #pragma once + +/*! \file type.h + Math types alias file used to abstract math types and not depend on any library. + As long as it's implemented here. +*/ + +/*! \typedef Bk::uint +\brief Simplefied name for unsigned int +*/ + +/*! \typedef Bk::Vec2 +\brief Wrapper around glm::vec2 +*/ + +/*! \typedef Bk::Vec3 +\brief Wrapper around glm::vec3 +*/ + +/*! \typedef Bk::Vec4 +\brief Wrapper around glm::vec4 +*/ + +/*! \typedef Bk::Mat3 +\brief Wrapper around glm::mat3 +*/ + +/*! \typedef Bk::Mat4 +\brief Wrapper around glm::mat4 +*/ + #include namespace Bk