From: Costa Shulyupin <constantine.shulyupin@gmail.com>
Date: Thu, 21 Apr 2022 17:30:37 +0000 (+0300)
Subject: add doxygen comment to cell::edges
X-Git-Tag: 4.0.0~71^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f566173158b986945681436ab029e1bc3f771dd1;p=graphviz

add doxygen comment to cell::edges

The first two lines (brief) will shown in description
of the `struct cell`

The list will be shown in detailed description of cell::edges
---

diff --git a/lib/ortho/maze.h b/lib/ortho/maze.h
index ece0f2aa0..fe28381de 100644
--- a/lib/ortho/maze.h
+++ b/lib/ortho/maze.h
@@ -34,7 +34,15 @@ enum {M_RIGHT=0, M_TOP, M_LEFT, M_BOTTOM};
 typedef struct cell {
   int flags;
   int nedges;
-  sedge* edges[6];
+  sedge* edges[6]; /**< @brief up to six links (@ref sedge) between
+                        four @ref sides (@ref snode) of the cell
+                            1. ┘ left — top
+                            2. └ top — right
+                            3. ┐ left — bottom
+                            4. ┌ bottom — right
+                            5. │ top — bottom
+                            6. ─ left — right
+                    */
   int nsides;
   snode** sides;
   boxf  bb;