From: Costa Shulyupin <constantine.shulyupin@gmail.com>
Date: Sun, 24 Apr 2022 07:34:59 +0000 (+0300)
Subject: add doxygen comments to snode
X-Git-Tag: 6.0.1~22^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d90b7518e6e1e4ce745ea6fccf635001d7cba6b6;p=graphviz

add doxygen comments to snode

and make doxygen comments from regular.
---

diff --git a/lib/ortho/sgraph.h b/lib/ortho/sgraph.h
index 26af31af4..61708ce11 100644
--- a/lib/ortho/sgraph.h
+++ b/lib/ortho/sgraph.h
@@ -17,15 +17,21 @@
 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;