#194: Add documentation for GraphView

Context

Modified files

Detailed major modifications

TODO

include/aidge/graph/GraphView.hpp

@@ -295,9 +295,10 @@ public:
      * compatible with the selected kernel.
      * If not, add a Transpose Operator.
      * 4 - Propagate Tensor dimensions through the consecutive Operators.
-     @params string: backend Backend used, default is cpu
+     @params backend: Backend used, default is cpu
      @params Aidge Datatype: datatype used, default is float32
-     @params vector of vector of DimSize_t: dims
+     @params device: Device to be set
+     @params dims: vector of vector of DimSize_t: dims
      */
     void compile(const std::string& backend = "cpu",
                  const Aidge::DataType datatype = DataType::Float32,
@@ -312,6 +313,7 @@ public:
      * - Updates are made in node dependencies order, because if dims have changed
      *   at any point in the graph, it must de propagated correctly to all succeeding nodes;
      * - It handles cyclic dependencies correctly (currently only induced by the Memorize_Op).
+     * @param dims: vector of vector of dimensions of the inputs of the graphView
      * @return bool Whether it succeeded or not (failure can either raise an exception or return false)
      */
     bool forwardDims(const std::vector<std::vector<DimSize_t>>& dims = {}, bool allowDataDependency = false);