Slendi/smath
1
0
Fork 0
mirror of https://github.com/slendidev/smath.git synced 2026-03-17 02:26:50 +02:00
Code Activity

docs: Ignore macros the user should not be aware of

Browse Source 
Signed-off-by: Slendi <slendi@socopon.com>
This commit is contained in:
Slendi
2026-03-12 09:16:30 +02:00
parent cf490494c3
commit e063b10af5
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/smath/smath.hpp
View File

@@ -33,6 +33,10 @@
#include <type_traits> #include <type_traits>
#ifndef SMATH_ANGLE_UNIT #ifndef SMATH_ANGLE_UNIT
/**
* @brief Angle unit to be used for the actual values. Can be rad, deg, or
* turns.
*/
#define SMATH_ANGLE_UNIT rad #define SMATH_ANGLE_UNIT rad
#endif // SMATH_ANGLE_UNIT #endif // SMATH_ANGLE_UNIT
@@ -46,8 +50,10 @@ struct Vec;
namespace detail namespace detail
{ {
/// \cond DO_NOT_DOCUMENT
#define SMATH_STR(x) #x #define SMATH_STR(x) #x
#define SMATH_XSTR(x) SMATH_STR(x) #define SMATH_XSTR(x) SMATH_STR(x)
/// \endcond
consteval auto streq(const char *a, const char *b) -> bool consteval auto streq(const char *a, const char *b) -> bool
{ {
@@ -212,6 +218,8 @@ public:
// Member accesses // Member accesses
// NOTE: This can (probably) be improved with C++26 reflection in the // NOTE: This can (probably) be improved with C++26 reflection in the
// future. // future.
/// \cond DO_NOT_DOCUMENT
#define VEC_ACC(component, req, idx) \ #define VEC_ACC(component, req, idx) \
constexpr auto component() noexcept -> T &requires(N >= req) { \ constexpr auto component() noexcept -> T &requires(N >= req) { \
return (*this)[idx]; \ return (*this)[idx]; \
@@ -239,6 +247,7 @@ public:
VEC_ACC(u, 1, 0) VEC_ACC(u, 1, 0)
VEC_ACC(v, 2, 1) VEC_ACC(v, 2, 1)
#undef VEC_ACC #undef VEC_ACC
/// \endcond
template<class... Args, std::size_t... Is> template<class... Args, std::size_t... Is>
constexpr void unpack_impl( constexpr void unpack_impl(
@@ -287,6 +296,7 @@ public:
} }
// Members // Members
/// \cond DO_NOT_DOCUMENT
#define VEC_OP(op) \ #define VEC_OP(op) \
constexpr auto operator op(Vec const &rhs) const noexcept -> Vec \ constexpr auto operator op(Vec const &rhs) const noexcept -> Vec \
{ \ { \
@@ -327,6 +337,7 @@ public:
VEC_OP_ASSIGN(*) VEC_OP_ASSIGN(*)
VEC_OP_ASSIGN(/) VEC_OP_ASSIGN(/)
#undef VEC_OP_ASSIGN #undef VEC_OP_ASSIGN
/// \endcond
constexpr auto operator==(Vec const &v) const noexcept -> bool constexpr auto operator==(Vec const &v) const noexcept -> bool
{ {