From 82c0be37cd46d7e53101336f68aef88cd71a975d Mon Sep 17 00:00:00 2001 From: anulax1225 Date: Mon, 29 Jan 2024 11:28:21 +0100 Subject: [PATCH] Added documentation to math file --- bakara/src/bakara/math/type.h | 46 +++++++++++++++-------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/bakara/src/bakara/math/type.h b/bakara/src/bakara/math/type.h index 849e905..c6a4ae7 100644 --- a/bakara/src/bakara/math/type.h +++ b/bakara/src/bakara/math/type.h @@ -1,42 +1,36 @@ #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 +Math types alias file used to abstract math types and not depend on any library. +As long as it's implemented here. */ #include namespace Bk { + /*! \typedef Bk::uint + Simplefied name for unsigned int + */ using uint = unsigned int; + /*! \typedef Bk::Vec2 + Wrapper around glm::vec2 + */ using Vec2 = glm::vec2; + /*! \typedef Bk::Vec3 + Wrapper around glm::vec3 + */ using Vec3 = glm::vec3; + /*! \typedef Bk::Vec4 + Wrapper around glm::vec4 + */ using Vec4 = glm::vec4; + /*! \typedef Bk::Mat3 + Wrapper around glm::mat3 + */ using Mat3 = glm::mat3; + /*! \typedef Bk::Mat4 + Wrapper around glm::mat4 + */ using Mat4 = glm::mat4; }