partition.h: add doxygen comments

diff --git a/lib/ortho/partition.h b/lib/ortho/partition.h
index 35a15c7a27fa485474ecabf1171cd65bcdb6b995..58960b3cc70aa07c36238f710e6b25e2fdb501e6 100644 (file)
--- 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);