#194: Add documentation for GraphView

Context

Modified files

Detailed major modifications

TODO

include/aidge/graph/GraphView.hpp

@@ -379,17 +379,17 @@ public:
      * Get the ranked list of nodes in the GraphView.
      * Node ranking if performed the following:
      * - The root node is put in the ranked list first (rank 1);
-     * - Then, its childs (in order of outputs) are added in the ranked list;
+     * - Then, its children (in order of outputs) are added in the ranked list;
      * - Then, its parents (in order of inputs) are added in the ranked list;
-     * - The childs and parents of the next node in the ranked list are then
+     * - The children and parents of the next node in the ranked list are then
      *   added to the list, and so on.
      * - Any remaining nodes have no path to the root node and are added in
-     *   arbitrary order. In this case, the ranking is not garanteed to be unique.
+     *   arbitrary order. In this case, the ranking is not guaranteed to be unique.
      *
-     * If the ranking cannot be garanteed to be unique, the second item indicates
-     * the rank from which unicity cannot be garanteed.
+     * If the ranking cannot be guaranteed to be unique, the second item indicates
+     * the rank from which unicity cannot be guaranteed.
      * @return std::pair<std::vector<NodePtr>, size_t> Pair with the list of ranked
-     * nodes and the size of the ranked sub-list where unicity is garanteed.
+     * nodes and the size of the ranked sub-list where unicity is guaranteed.
     */
     std::pair<std::vector<NodePtr>, size_t> getRankedNodes() const;