From 46263b01a7d6ebce5d61f337188dd9859d5511de Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= <git@maximilian-kessler.de>
Date: Sat, 4 Nov 2023 19:01:43 +0100
Subject: [PATCH] add documentation

---
 edmonds.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/edmonds.cpp b/edmonds.cpp
index 0574a31..83449be 100644
--- a/edmonds.cpp
+++ b/edmonds.cpp
@@ -4,6 +4,13 @@ using namespace ED;
 
 namespace Edmonds {
 
+/**
+ * @return List of vertices of the x-r path, where r is the root of the
+ * special blossom forest component x belongs to.
+ *
+ * @note This assumes that the values of μ, φ and ρ represent a special
+ * blossom forest on the graph when this method is called.
+ * **/
 std::vector<NodeId> path_to_forest_root(Graph const & graph, NodeId id)
 {
    std::vector<NodeId> retval;