fix(docs): remove comments in impl files

fburgerdev · fburgerdev · commit 1bd6fc86b113 · 2025-04-12T22:51:46.000+02:00
in order for code editor tool tips to use the doxygen comments
diff --git a/src/common_impl.hh b/src/common_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // holds
   template<class T, class... Args>
   bool holds(const Variant<Args...>& variant) {
     return std::holds_alternative<T>(variant);
diff --git a/src/core/asset_handle_impl.hh b/src/core/asset_handle_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // (constructor)
   template<class T>
   AssetHandle<T>::AssetHandle(UUID uuid, AssetAPI& asset_api)
     : _key(uuid), _api(&asset_api) {
@@ -28,12 +27,10 @@ namespace Parrot {
     }
   }
 
-  // bool (cast)
   template<class T>
   AssetHandle<T>::operator bool() const {
     return _api;
   }
-  // lock
   template<class T>
   SharedPtr<const T> AssetHandle<T>::lock() const {
     return std::static_pointer_cast<const T>(
diff --git a/src/core/factory_impl.hh b/src/core/factory_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // create
   template<class T, class Base>
   UniquePtr<Base> BasicFactory<T, Base>::create() const {
     return std::make_unique<T>(static_cast<const T&>(*this));
diff --git a/src/core/script_impl.hh b/src/core/script_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // getID
   template<class T>
   usize Script::getID() {
     return typeid(T).hash_code();
diff --git a/src/core/scriptable_impl.hh b/src/core/scriptable_impl.hh
@@ -1,8 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // script
-  // :: get
   template<ScriptType T>
   T& Scriptable::getScript() {
     auto it = _scripts.find(Script::getID<T>());
@@ -15,7 +13,6 @@ namespace Parrot {
     /* TODO: assert(it != _scripts.end()) */
     return reinterpret_cast<const T&>(*it->second);
   }
-  // :: add
   template<ScriptType T, class... Args>
   T& Scriptable::addScript(Args&&... args) {
     auto result = _scripts.emplace(
@@ -27,7 +24,6 @@ namespace Parrot {
     script->onAttach();
     return reinterpret_cast<T&>(*script);
   }
-  // :: remove
   template<ScriptType T>
   void Scriptable::removeScript() {
     auto it = _scripts.find(Script::getID<T>());
diff --git a/src/ecs/basic_component_impl.hh b/src/ecs/basic_component_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // getID
   template<class T>
   usize BasicComponent<T>::getID() const {
     return typeid(BasicComponent<T>).hash_code();
diff --git a/src/ecs/entity_impl.hh b/src/ecs/entity_impl.hh
@@ -1,13 +1,10 @@
 #pragma once
 
 namespace Parrot {
-  // component
-  // :: has
   template<class T>
   bool Entity::hasComponent() const {
     return _components.contains(typeid(T).hash_code());
   }
-  // :: get
   template<class T>
   T& Entity::getComponent() {
     return dynamic_cast<T&>(*_components.at(typeid(T).hash_code()));
@@ -16,14 +13,12 @@ namespace Parrot {
   const T& Entity::getComponent() const {
     return dynamic_cast<const T&>(*_components.at(typeid(T).hash_code()));
   }
-  // :: add
   template<class T, class... Args>
   T& Entity::addComponent(Args&&... args) {
     auto component = std::make_unique<T>(std::forward<Args>(args)...);
     _components.emplace(typeid(T).hash_code(), std::move(component));
     return getComponent<T>();
   }
-  // :: remove
   template<class T>
   void Entity::removeComponent() {
     _components.erase(typeid(T).hash_code());
diff --git a/src/ecs/scene_impl.hh b/src/ecs/scene_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // queryEntities
   template<class T>
   List<Entity*> Scene::queryEntities() {
     List<Entity*> found;
diff --git a/src/graphics/material_impl.hh b/src/graphics/material_impl.hh
@@ -1,9 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  //* MaterialNode
-  // parse
-  // :: vec
   template<class T, usize N>
   Vec<T, N> MaterialNode::parseVec(const auto& node) {
     Vec<T, N> vec;
@@ -12,7 +9,6 @@ namespace Parrot {
     }
     return vec;
   }
-  // :: mat
   template<class T, usize N, usize M>
   Mat<T, N, M> MaterialNode::parseMat(const auto& node) {
     Mat<T, N, M> mat;
diff --git a/src/graphics/mesh_impl.hh b/src/graphics/mesh_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // (constructor)
   template<class Vertices, class Indices>
   Mesh::Mesh(Vertices&& vertices, Indices&& indices)
     : vertices(std::forward<Vertices>(vertices)),
diff --git a/src/graphics/opengl/context_opengl_impl.hh b/src/graphics/opengl/context_opengl_impl.hh
@@ -2,28 +2,24 @@
 
 namespace Parrot {
   namespace OpenGL {
-    // createVertexBuffer
     template<class... Args>
     VertexBuffer& Context::createVertexBuffer(Args&&... args) {
       return _vertex_buffers.try_emplace(
         generateUUID(), std::forward<Args>(args)...
       ).first->second;
     }
-    // createIndexBuffer
     template<class... Args>
     IndexBuffer& Context::createIndexBuffer(Args&&... args) {
       return _index_buffers.try_emplace(
         generateUUID(), std::forward<Args>(args)...
       ).first->second;
     }
-    // createUniformBuffer
     template<class... Args>
     UniformBuffer& Context::createUniformBuffer(Args&&... args) {
       return _uniform_buffers.try_emplace(
         generateUUID(), std::forward<Args>(args)...
       ).first->second;
     }
-    // createVertexArray
     template<class... Args>
     VertexArray& Context::createVertexArray(Args&&... args) {
       return _vertex_arrays.try_emplace(
diff --git a/src/graphics/opengl/std140_opengl_impl.hh b/src/graphics/opengl/std140_opengl_impl.hh
@@ -2,16 +2,13 @@
 
 namespace Parrot {
   namespace OpenGL {
-    // roundToBaseAlign
     constexpr usize roundToBaseAlign(usize offset, usize base_align) {
       if (base_align > 0 && offset % base_align) {
         return (offset / base_align + 1) * base_align;
       }
       return offset;
     }
 
-    // setSTD140
-    // :: vec
     template<class T>
     void setSTD140(Vec2<T> vec, List<uchar>::iterator it) {
       setSTD140(vec.x, it + SIZE_STD140<T> *0);
@@ -30,14 +27,12 @@ namespace Parrot {
       setSTD140(vec.z, it + SIZE_STD140<T> *2);
       setSTD140(vec.w, it + SIZE_STD140<T> *3);
     }
-    // :: arr
     template<class T, usize N>
     void setSTD140(const Array<T, N>& arr, List<uchar>::iterator it) {
       for (usize i = 0; i < N; ++i) {
         setSTD140(arr.at(i), it + roundToBaseAlign(SIZE_STD140<T>) * i);
       }
     }
-    // :: mat
     template<class T, usize N, usize M>
     void setSTD140(const Mat<T, N, M>& mat, List<uchar>::iterator it) {
       for (usize m = 0; m < M; ++m) {
@@ -48,7 +43,6 @@ namespace Parrot {
         }
       }
     }
-    // :: struct
     template<usize Index, class... Types>
     void setSTD140(const Tuple<Types...>& tuple, List<uchar>::iterator it) {
       if constexpr (Index < sizeof...(Types)) {
@@ -63,7 +57,6 @@ namespace Parrot {
       setSTD140<0>(tuple, it);
     }
 
-    // createSTD140
     template<class T>
     List<uchar> createSTD140(const T& value) {
       List<uchar> out(SIZE_STD140<T>);
diff --git a/src/graphics/opengl/surface_opengl_impl.hh b/src/graphics/opengl/surface_opengl_impl.hh
@@ -2,7 +2,6 @@
 
 namespace Parrot {
   namespace OpenGL {
-    // embedList
     template<usize N, class T>
     Array<T, N> SurfaceBlock::embedList(const List<T>& list) {
       Array<T, N> out;
diff --git a/src/utils/logger_impl.hh b/src/utils/logger_impl.hh
@@ -2,41 +2,34 @@
 #include "logger.hh"
 
 namespace Parrot {
-  // log
   template<LogLevel Level, class... Args>
   void Logger::log(strview scope, strview fmt, const Args&... args) {
     if (uint(Level) >= uint(getLevel(scope))) {
       logHead(scope, Level);
       logBody(fmt, args...);
     }
   }
-  // :: trace
   template<class... Args>
   void Logger::logTrace(strview scope, strview fmt, const Args&... args) {
     log<LogLevel::TRACE>(scope, fmt, args...);
   }
-  // :: debug
   template<class... Args>
   void Logger::logDebug(strview scope, strview fmt, const Args&... args) {
     log<LogLevel::DEBUG>(scope, fmt, args...);
   }
-  // :: info
   template<class... Args>
   void Logger::logInfo(strview scope, strview fmt, const Args&... args) {
     log<LogLevel::INFO>(scope, fmt, args...);
   }
-  // :: warning
   template<class... Args>
   void Logger::logWarning(strview scope, strview fmt, const Args&... args) {
     log<LogLevel::WARNING>(scope, fmt, args...);
   }
-  // :: error
   template<class... Args>
   void Logger::logError(strview scope, strview fmt, const Args&... args) {
     log<LogLevel::ERROR>(scope, fmt, args...);
   }
 
-  // logBody
   template<class First, class... Rest>
   void Logger::logBody(strview fmt, const First& first, const Rest&... rest) {
     for (auto it = fmt.begin(); it != fmt.end(); ++it) {
diff --git a/src/utils/math_3d_impl.hh b/src/utils/math_3d_impl.hh
@@ -1,7 +1,6 @@
 #pragma once
 
 namespace Parrot {
-  // calcTranslationMatrix
   template<typename T>
   Mat4x4<T> calcTranslationMatrix(const Vec3<T>& translation) {
     Mat4x4<T> out = identity<T, 4>();
@@ -10,7 +9,6 @@ namespace Parrot {
     out.at(2, 3) = translation.z;
     return out;
   }
-  // calcScaleMatrix
   template<typename T>
   Mat4x4<T> calcScaleMatrix(const Vec3<T>& scale) {
     Mat4x4<T> out = identity<T, 4>();
@@ -19,7 +17,6 @@ namespace Parrot {
     out.at(2, 2) *= scale.z;
     return out;
   }
-  // calcRotationMatrix (using euler radius)
   template<typename T>
   Mat4x4<T> calcRotationMatrix(const Vec3<T>& euler_rotation) {
     Mat4x4<T> out = zeros<T, 4>();
@@ -30,33 +27,26 @@ namespace Parrot {
     T sinc = std::sin(euler_rotation.z);
     T cosc = std::cos(euler_rotation.z);
 
-    // row 1
     out.at(0, 0) = cosa * cosc - sina * sinc * sinb;
     out.at(0, 1) = cosa * sinc + sina * sinb * cosc;
     out.at(0, 2) = -sina * cosb;
-    // row 2
     out.at(1, 0) = -sinc * cosb;
     out.at(1, 1) = cosb * cosc;
     out.at(1, 2) = sinb;
-    // row 3
     out.at(2, 0) = sina * cosc + cosa * sinc * sinb;
     out.at(2, 1) = sina * sinc - cosa * sinb * cosc;
     out.at(2, 2) = cosa * cosb;
-    // row 4
     out.at(3, 3) = 1;
     return out;
   }
 
-  //* Transform
-  // calcLocalModelMatrix
   template<class T>
   Mat4x4<T> Transform<T>::calcLocalModelMatrix() const {
     Mat4x4<T> translation_matrix = calcTranslationMatrix(position);
     Mat4x4<T> rotation_matrix = calcRotationMatrix(rotation);
     Mat4x4<T> scale_matrix = calcScaleMatrix(scale);
     return translation_matrix * rotation_matrix * scale_matrix;
   }
-  // calcLocalViewMatrix
   template<class T>
   Mat4x4<T> Transform<T>::calcLocalViewMatrix() const {
     Mat4x4<T> translation_matrix = calcTranslationMatrix(-position);
diff --git a/src/utils/math_basic_impl.hh b/src/utils/math_basic_impl.hh
@@ -1,13 +1,11 @@
 #pragma once
 
 namespace Parrot {
-  // clamp
   template<class T>
   constexpr T clamp(T value, T min, T max) {
     return (value < min ? min : (value > max ? max : value));
   }
 
-  // min
   template<class First, class... Rest>
   constexpr First min(First left, Rest&&... rest) {
     if constexpr (sizeof...(Rest)) {
@@ -18,7 +16,6 @@ namespace Parrot {
       return left;
     }
   }
-  // max
   template<class First, class... Rest>
   constexpr First max(First left, Rest&&... rest) {
     if constexpr (sizeof...(Rest)) {
@@ -30,7 +27,6 @@ namespace Parrot {
     }
   }
 
-  // pow
   template<class T>
   constexpr T pow(T base, usize exponent) {
     T out = (T)1.0;
diff --git a/src/utils/math_matrix_impl.hh b/src/utils/math_matrix_impl.hh
diff --git a/src/utils/math_perlin_impl.hh b/src/utils/math_perlin_impl.hh
diff --git a/src/utils/math_random_impl.hh b/src/utils/math_random_impl.hh
diff --git a/src/utils/serial_node_impl.hh b/src/utils/serial_node_impl.hh

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`#pragma once`
`2`	`2`
`3`	`3`	`namespace Parrot {`
`4`		`- // (constructor)`
`5`	`4`	`template<class T>`
`6`	`5`	`AssetHandle<T>::AssetHandle(UUID uuid, AssetAPI& asset_api)`
`7`	`6`	`: _key(uuid), _api(&asset_api) {`
`@@ -28,12 +27,10 @@ namespace Parrot {`
`28`	`27`	`}`
`29`	`28`	`}`
`30`	`29`
`31`		`- // bool (cast)`
`32`	`30`	`template<class T>`
`33`	`31`	`AssetHandle<T>::operator bool() const {`
`34`	`32`	`return _api;`
`35`	`33`	`}`
`36`		`- // lock`
`37`	`34`	`template<class T>`
`38`	`35`	`SharedPtr<const T> AssetHandle<T>::lock() const {`
`39`	`36`	`return std::static_pointer_cast<const T>(`