add a comment

wildmeshing · Apr 28, 2024 · 796b2f4 · 796b2f4
1 parent 771f0c9
commit 796b2f4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/wmtk/operations/EdgeSplit.hpp b/src/wmtk/operations/EdgeSplit.hpp
@@ -5,7 +5,6 @@
 #include "attribute_new/SplitNewAttributeStrategy.hpp"
 
 namespace wmtk::operations {
-
 class EdgeSplit : public Operation
 {
 public:
@@ -30,6 +29,9 @@ class EdgeSplit : public Operation
         const wmtk::operations::SplitRibBasicStrategy& rib =
             wmtk::operations::SplitRibBasicStrategy::Default);
 
+    /**
+     * @return the new simplex, toward to the next simplex along the splited line
+     */
     std::vector<simplex::Simplex> execute(const simplex::Simplex& simplex) override;
     std::vector<simplex::Simplex> unmodified_primitives(
         const simplex::Simplex& simplex) const override;