doxygen comment for emitSearchGraph

diff --git a/lib/ortho/ortho.c b/lib/ortho/ortho.c
index a87168381cabc5bec168bc56ee8c4f320d40bd1b..308f1d368c5d72b414576d818363d18737fd27ad 100644 (file)
--- a/lib/ortho/ortho.c
+++ b/lib/ortho/ortho.c
@@ -1498,6 +1498,16 @@ emitEdge (FILE* fp, Agedge_t* e, route rte, maze* m, boxf bb)
     return bb;
 }
 
+/**
+ * @brief dumps in dot format @ref cells and @ref edges of
+ * @ref sgraph for debugging
+ *
+ * The routine uses coordinates of @ref cells calculated
+ * from @ref gcells.
+ * Coordinates of @ref gcellg are calculated by original
+ * specified graph layout engine.
+ */
+
 static void
 emitSearchGraph (FILE* fp, sgraph* sg)
 {