]> granicus.if.org Git - graphviz/commitdiff
add doxygen comments to snode
authorCosta Shulyupin <constantine.shulyupin@gmail.com>
Sun, 24 Apr 2022 07:34:59 +0000 (10:34 +0300)
committerMatthew Fernandez <matthew.fernandez@gmail.com>
Mon, 29 Aug 2022 14:40:43 +0000 (07:40 -0700)
and make doxygen comments from regular.

lib/ortho/sgraph.h

index 26af31af4890b3a00da43e8aa3f7e3483923975e..61708ce118f954300eb36aad607953700c450773 100644 (file)
 typedef struct snode snode;
 typedef struct sedge sedge;
 
+/** @brief a node of search graph @ref sgraph,
+ * is created as a border segment between two adjusted cells of type @ref cell.
+ *
+ * Nodes and a search graph are created by functions @ref mkMazeGraph, @ref findSVert and @ref createSNode.
+ */
+
 struct snode {
   int n_val, n_idx;
   snode* n_dad;
   sedge* n_edge;
   short   n_adj;
   short   save_n_adj;
-  struct cell* cells[2];
+  struct cell* cells[2]; ///< [0] - left or botom, [1] - top or right adjusted cell
 
-    /* edges incident on this node 
+    /** @brief edges incident on this node
      * -- stored as indices of the edges array in the graph
      */
   int* adj_edge_list;