]> granicus.if.org Git - graphviz/commitdiff
doxygen for fdpgen
authorCosta Shulyupin <constantine.shulyupin@gmail.com>
Thu, 6 Oct 2022 18:50:53 +0000 (21:50 +0300)
committerMatthew Fernandez <matthew.fernandez@gmail.com>
Wed, 14 Dec 2022 16:12:04 +0000 (08:12 -0800)
Add exported API functions to file description.

lib/fdpgen/fdpinit.c

index 3a4cef08576c286fa2d4ace79bd22908b42b5118..5821884f7b4b923c36ce0bd5cdcf5f46122d0a9c 100644 (file)
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @brief API fdpgen/fdp.h: @ref fdp_init_node_edge, @ref fdp_cleanup
+ */
+
 /*************************************************************************
  * Copyright (c) 2011 AT&T Intellectual Property 
  * All rights reserved. This program and the accompanying materials
@@ -148,3 +153,13 @@ void fdp_cleanup(graph_t * g)
     }
     fdp_cleanup_graph(g);
 }
+
+/**
+ * @dir lib/fdpgen
+ * @brief [Force-Directed Placement](https://en.wikipedia.org/wiki/Force-directed_graph_drawing) layout engine, API fdpgen/fdp.h
+ * @ingroup engines
+ *
+ * [FDP layout user manual](https://graphviz.org/docs/layouts/fdp/)
+ *
+ * Other @ref engines
+ */