aidge#199: Add documentation for Node

aidge#199 (closed)

Context

update doc API NOde

Modified files

• Node.hpp: several doxygen descriptions have been updated
• pybind_node.cpp: several descriptions have been changed

Detailed major modifications

TODO

include/aidge/graph/Node.hpp

@@ -247,6 +247,7 @@ public:
   /**
    * @brief Returns the number of free data inputs of the Node
    * (i.e. data inputs that are not linked to an other node)
+   * @warning Node cannot run until all of its inputs are filled"
    * @return IOIndex_t
    */
   IOIndex_t getNbFreeDataInputs() const;
@@ -298,6 +299,7 @@ public:
 
   /**
    * @brief Number of inputs linked to a Parent's output.
+   * @warning Inputs that are not linked will prevent the node from functioning
    * @return IOIndex_t
    */
   IOIndex_t nbValidInputs() const;