#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
- * -  : Set of nodes included in the graphview with names
+ * - mNodeRegistry : 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 output number
  */
@@ -288,14 +288,14 @@ public:
      * @brief Assert Datatype, Backend, data format and dimensions along the GraphView are coherent.
      * If not, apply the required transformations.
      * @details Sets the GraphView ready for computation in four steps:
-     * 1 - Assert input Tensors' datatype is compatible with each Operator's datatype.
+     * - Assert input Tensors' datatype is compatible with each Operator's datatype.
      * If not, a conversion Operator is inserted.
-     * 2 - Assert input Tensors' backend is compatible with each Operator's backend.
+     * - Assert input Tensors' backend is compatible with each Operator's backend.
      * If not, add a Transmitter Operator.
-     * 3 - Assert data format (NCHW, NHWC, ...) of each Operator's input Tensor is
+     * - Assert data format (NCHW, NHWC, ...) of each Operator's input Tensor is
      * compatible with the selected kernel.
      * If not, add a Transpose Operator.
-     * 4 - Propagate Tensor dimensions through the consecutive Operators.
+     * - Propagate Tensor dimensions through the consecutive Operators.
      @params backend: Backend used, default is cpu
      @params Aidge Datatype: datatype used, default is float32
      @params device: Device to be set