From: Costa Shulyupin <constantine.shulyupin@gmail.com>
Date: Sat, 28 May 2022 04:11:52 +0000 (+0300)
Subject: partition.h: add doxygen comments
X-Git-Tag: 5.0.1~24^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0dff6919f3ed4bc2b15bb6ebbe97e1f8038bea4e;p=graphviz

partition.h: add doxygen comments
---

diff --git a/lib/ortho/partition.h b/lib/ortho/partition.h
index 35a15c7a2..58960b3cc 100644
--- a/lib/ortho/partition.h
+++ b/lib/ortho/partition.h
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @brief function @ref partition, subroutine of @ref mkMaze
+ */
+
 /*************************************************************************
  * Copyright (c) 2011 AT&T Intellectual Property 
  * All rights reserved. This program and the accompanying materials
@@ -12,4 +17,12 @@
 
 #include <ortho/maze.h>
 
+/**
+ * @brief partitions space around cells (nodes) into rectangular tiles
+ * @param[in] cells rectangular borders of user's input graph's nodes
+ * @param[in] bb range of the space to partition
+ * @param[out] nrects number of tiles
+ * @returns array of the tiles
+ */
+
 boxf* partition(cell* cells, int ncells, int* nrects, boxf bb);