Clean code and add documentation

CURA-12743

Author: wawanbreton

include/project.h

@@ -15,6 +15,23 @@ class Vector3F;
 
 using Polygon = std::vector<Point2F>;
 
+/**
+ * \brief Projects a 2D stroke polygon onto a 3D mesh and returns the resulting 2D polygons in UV space.
+ * \param stroke_polygon           The 2D stroke polygon to project.
+ * \param mesh_vertices            The coordinates of the 3D vertices of the mesh.
+ * \param mesh_indices             The mesh faces as indices into the vertex array, which may be empty of the mesh doesn't have indices.
+ * \param mesh_uv                  The UV coordinates for each mesh vertex.
+ * \param mesh_faces_connectivity  For each face of the mesh, contains the 3 indices of the adjacent faces, or -1 is edge is not connected.
+ * \param texture_width            The width of the texture in pixels.
+ * \param texture_height           The height of the texture in pixels.
+ * \param camera_projection_matrix The camera projection matrix.
+ * \param is_camera_perspective    True if the camera uses perspective projection, false for orthographic.
+ * \param viewport_width           The width of the viewport in pixels.
+ * \param viewport_height          The height of the viewport in pixels.
+ * \param camera_normal            The normal vector of the camera.
+ * \param face_id                  The ID of the initial face to project onto, other will be propagated using connectivity information.
+ * \return A vector of polygons in UV space resulting from the projection.
+ */
 std::vector<Polygon> project(
     const std::span<Point2F>& stroke_polygon,
     const std::span<Point3F>& mesh_vertices,

src/project.cpp

@@ -162,7 +162,7 @@ std::vector<Polygon> toPolygons(const ClipperLib::Paths& paths)
             result_polygon.emplace_back(point.X / CLIPPER_PRECISION, point.Y / CLIPPER_PRECISION);
         }
 
-        result.emplace_back(std::move(result_polygon));
+        result.push_back(std::move(result_polygon));
     }
 
     return result;
@@ -195,10 +195,6 @@ std::vector<Polygon> project(
         const uint32_t candidate_face_id = *iterator;
         candidate_faces.erase(iterator);
 
-        // if (processed_faces.contains(candidate_face_id))
-        // {
-        //     continue;
-        // }
         processed_faces.insert(candidate_face_id);
 
         const Face face = getFace(mesh_indices, candidate_face_id);