]> granicus.if.org Git - graphviz/commitdiff
doxygen comments for updateWt and updateWts
authorCosta Shulyupin <constantine.shulyupin@gmail.com>
Tue, 10 May 2022 15:59:22 +0000 (18:59 +0300)
committerMatthew Fernandez <matthew.fernandez@gmail.com>
Tue, 24 May 2022 02:13:42 +0000 (19:13 -0700)
lib/ortho/maze.c

index 525e9c654bf5ed739f69792ac5ba4c497dfacce3..03102a7a6094f023476194063c54dbe22cb82187 100644 (file)
@@ -152,11 +152,14 @@ static Dtdisc_t hdictDisc = {
 #define CHANSZ(w) (((w)-3)/2)
 #define IS_SMALL(v) (CHANSZ(v) < 2)
 
-/* updateWt:
+/**
+ * @brief updates single @ref sedge::weight
+ *
  * At present, we use a step function. When a bound is reached, the weight
  * becomes huge. We might consider bumping up the weight more gradually, the
  * thinner the channel, the faster the weight rises.
  */
+
 static void
 updateWt (sedge* ep, int sz)
 {
@@ -167,12 +170,15 @@ updateWt (sedge* ep, int sz)
     }
 }
 
-/* updateWts:
+/**
+ * @brief updates @ref sedge::weight of cell edges
+ *
  * Iterate over edges in a cell, adjust weights as necessary.
  * It always updates the bent edges belonging to a cell.
  * A horizontal/vertical edge is updated only if the edge traversed
  * is bent, or if it is the traversed edge.
  */
+
 void
 updateWts (sgraph* g, cell* cp, sedge* ep)
 {