#194: Add documentation for GraphView

Context

Modified files

Detailed major modifications

TODO

include/aidge/graph/GraphView.hpp

@@ -42,7 +42,7 @@ enum class DataType;
  * - mName: The name of the GraphView
  * - mRootNode: The root of the GraphView, an arbitrary Node of the GraphView
  * - mNodes: The set of Nodes included in the GraphView
- * - mNodeRegistry: Set of nodes included in the graphview with names
+ * -  : Set of nodes included in the graphview with names
  * - mInputNodes: GraphView inputs IOIndex_t designates the input number
  * - mOutputNodes: GraphView outputs IOIndex_t designates the input number
  */
@@ -98,9 +98,11 @@ public:
 ///////////////////////////////////////////////////////
 //        FUNCTIONAL DESCRIPTION
 ///////////////////////////////////////////////////////
-/**
- * @todo
- */
+  /**
+   * @brief Functional operator for user-friendly connection interface using an ordered set of Connectors.
+   * @param ctors
+   * @return Connector
+   */
     Connector operator()(const std::vector<Connector> ctors);
 
 ///////////////////////////////////////////////////////
@@ -575,7 +577,6 @@ public:
      * @brief Clone the GraphView with shared Operators. It is a new GraphView, with cloned Nodes, but the new Nodes refer to the same Operators as the original ones.
      * @return std::shared_ptr<GraphView>
      */
-    //@todo here i am
     inline std::shared_ptr<GraphView> cloneSharedOperators() const {
         return cloneCallback(&Node::cloneSharedOperators);
     }
@@ -596,7 +597,7 @@ public:
         return cloneCallback(&Node::clone);
     }
 
-    /** TODO: reformulate
+    /** TODO: understand and reformulate (and see above clones)
      * @brief Clone the current GraphView using a callback function for the Node cloning, allowing to specify how each
      * Node should be cloned or replaced by another Node type, or removed (i.e. replaced by identity).
      * When a Node is removed, the clone() method automatically finds the next valid parent in line, going backward in
@@ -616,8 +617,8 @@ public:
 
     /**
      * @brief Force update of GraphView inputs/outputs.
-     * It may be necessary to force the update of GraphView inputs/outputs when
-     * connections are added or removed inside the GraphView **after** the nodes
+     * It may be necessary to force the update of GraphView inputs/outputs when Nodes
+     * and connections are added or removed inside the GraphView **after** the nodes
      * were added.
      */
     void updateInputsOutputs();
@@ -646,11 +647,13 @@ private:
      * inputs/outputs after adding this node.
      * @param nodePtr
      */
+    //@todo 100+ lines =(
     void updateInputsOutputsNew(NodePtr newNode);
 
+    //@todo 100+ lines =(
     /**
      * @brief Automatically update GraphView inputs/outputs with a Node removed, checking if
-     * it this Node was an input/output for the graph and if this node childs become new inputs/outputs
+     * it this Node was an input/output for the graph and if this node's children become new inputs/outputs
      * for the graph.
      * @param nodePtr
      */
@@ -663,7 +666,7 @@ private:
 };
 
 /**
- * Create a GraphView containing all nodes with a path to given argument.
+ * Create a GraphView containing all nodes with a path to given Node.
  * @param node Initial node to construct the graph.
  * @return GraphView GraphView containing all nodes with a path to node.
 */