From 47ee48d58b7aef2a25b2b238eb99f78eb700056e Mon Sep 17 00:00:00 2001
From: thibault allenet <thibault.allenet@cea.fr>
Date: Fri, 22 Sep 2023 12:07:12 +0000
Subject: [PATCH] Add documentation for insertParent
---
include/aidge/graph/GraphView.hpp | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/include/aidge/graph/GraphView.hpp b/include/aidge/graph/GraphView.hpp
index 39e18a87a..7a2b4bac0 100644
--- a/include/aidge/graph/GraphView.hpp
+++ b/include/aidge/graph/GraphView.hpp
@@ -323,11 +323,11 @@ public:
/**
* @brief Insert a node (newParentNode) as a parent of the passed node (childNode).
*
- * @param childNode
- * @param newParentNode
- * @param childInputTensorIdx
- * @param newParentInputTensorIdx
- * @param newParentOutputTensorIdx
+ * @param childNode Node that gets a new parent.
+ * @param newParentNode Inserted Node.
+ * @param childInputTensorIdx Index of the input Tensor for the childNode linked to the inserted Node output.
+ * @param newParentInputTensorIdx Index of the input Tensor for the newParentNode linked to the former parent of childNode.
+ * @param newParentOutputTensorIdx Index of the output Tensor for the newParentNode linked to the childNode's input Tensor.
*/
void insertParent(NodePtr childNode,
NodePtr newParentNode,
--
GitLab