[collision-query] Add nolints and doxygen comments

Author: IAmNotHanni

include/inexor/vulkan-renderer/world/collision.hpp

@@ -28,9 +28,15 @@ class RayCubeCollision {
     glm::vec3 m_nearest_cube_edge;
 
 public:
+    /// @brief Default constructor
+    /// @param The cube to check collisions with
+    /// @param ray The start point of the ray
+    /// @param dir The direction of the ray
+    /// @param The intersection between ray and vertex geometry of the cube which was found
     RayCubeCollision(std::shared_ptr<T> cube, glm::vec3 ray, glm::vec3 dir,
                      std::optional<glm::vec3> vertex_intersection = std::nullopt);
 
+    /// @note This method returns a copy of the cube, not a const reference.
     [[nodiscard]] std::shared_ptr<T> cube() const noexcept {
         return m_cube;
     }

src/vulkan-renderer/world/collision.cpp

@@ -12,8 +12,8 @@
 namespace inexor::vulkan_renderer::world {
 
 template <typename T>
-RayCubeCollision<T>::RayCubeCollision(const std::shared_ptr<T> cube, const glm::vec3 ray_pos, const glm::vec3 ray_dir,
-                                      const std::optional<glm::vec3> vertex_intersection)
+RayCubeCollision<T>::RayCubeCollision(const std::shared_ptr<T> cube, const glm::vec3 ray_pos, // NOLINT
+                                      const glm::vec3 ray_dir, const std::optional<glm::vec3> vertex_intersection)
     : m_cube(cube), m_vertex_intersection(vertex_intersection) {
 
     /// In order to work with cubes of arbitrary size, this lambda calculates the center of a cube's face with respect

src/vulkan-renderer/world/collision_query.cpp

@@ -37,8 +37,8 @@ bool ray_box_collision(const std::array<glm::vec3, 2> &box_bounds, const glm::ve
     return !((tmin > tzmax) || (tzmin > tmax));
 }
 
-std::optional<glm::vec3> ray_cube_vertex_intersection(const std::shared_ptr<Cube> cube, const glm::vec3 pos,
-                                                      const glm::vec3 dir) {
+std::optional<glm::vec3> ray_cube_vertex_intersection(const std::shared_ptr<Cube> cube, // NOLINT
+                                                      const glm::vec3 pos, const glm::vec3 dir) {
     const auto cube_polygons = cube->polygons();
 
     // If the cube does not contain any vertex data, no collision with vertex data can take place inside of it.
@@ -76,8 +76,8 @@ std::optional<glm::vec3> ray_cube_vertex_intersection(const std::shared_ptr<Cube
     return vertex_intersection;
 }
 
-[[nodiscard]] bool is_bounding_box_and_bounding_sphere_hit(const std::shared_ptr<Cube> cube, const glm::vec3 pos,
-                                                           const glm::vec3 dir) {
+[[nodiscard]] bool is_bounding_box_and_bounding_sphere_hit(const std::shared_ptr<Cube> cube, // NOLINT
+                                                           const glm::vec3 pos, const glm::vec3 dir) {
     // We need to pass this into glm::intersectRaySphere by reference although we are not interested in it.
     auto intersection_distance{0.0f};
     const auto bounding_sphere_radius = static_cast<float>(glm::sqrt(3) * cube->size()) / 2.0f;
@@ -98,8 +98,8 @@ std::optional<glm::vec3> ray_cube_vertex_intersection(const std::shared_ptr<Cube
     return true;
 }
 
-std::optional<RayCubeCollision<Cube>> ray_cube_collision_check(const std::shared_ptr<Cube> cube, const glm::vec3 pos,
-                                                               const glm::vec3 dir,
+std::optional<RayCubeCollision<Cube>> ray_cube_collision_check(const std::shared_ptr<Cube> cube, // NOLINT
+                                                               const glm::vec3 pos, const glm::vec3 dir,
                                                                const std::optional<std::uint32_t> grid_level_counter) {
 
     if (cube->type() == Cube::Type::EMPTY || !is_bounding_box_and_bounding_sphere_hit(cube, pos, dir)) {