#194: Add documentation for GraphView

Context

Modified files

Detailed major modifications

TODO

include/aidge/graph/GraphView.hpp

@@ -380,11 +380,11 @@ public:
     */
     std::pair<std::vector<NodePtr>, size_t> getRankedNodes() const;
 
-    //@todo here i am
     /**
+    // todo see comment in code
      * Get the nodes name according to the GraphView nodes ranking.
      * @param format The formatting string to be used with fmt::format().
-     * The usable positional arguments are the following:
+     * @details The usable positional arguments are the following:
      * {0} node name, {1} node type, {2} rank, {3} type rank
      * @param markNonUnicity If true, non unique ranking is prefixed with "?"
      * @return std::map<NodePtr, std::string> A map with the corresponding names
@@ -395,16 +395,21 @@ public:
      * @brief Remove a Node from the current GraphView scope without affecting its connections.
      * @param nodePtr Node to remove
      * @param includeLearnableParam Whether learnable parameters should also be removed. Default true.
+     * learnable params are removed only if they aren't used by other Nodes
      */
     void remove(NodePtr nodePtr, bool includeLearnableParam = true);
 
     // Surrounding nodes management
 
+    // not implemented yet
     void setInputId(IOIndex_t inID, IOIndex_t newNodeOutID);
 
     /**
+    //@todo here i am
      * @brief Include a Node to the current GraphView object.
-     * @param other_Nde Node to add.
+     * @details If the GraphView has no root Node (most likely this GraphView is empty)
+     * the added Node becomes the GraphView's root Node
+     * @param otherNode Node to add.
      * @param includeLearnableParam Include non-data inputs, like weights and biases
      * in the GraphView automatically. Default: true.
      */