From 232d025211c7ea754c5fb4cb36b54cb2ec3804e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Fri, 24 Apr 2020 01:02:10 +0200 Subject: [PATCH] Doxygen: Update calculate_cell_bounding_box() * Add note about problematic behaviour * Fix typos --- include/gds-render/geometric/cell-geometrics.h | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/include/gds-render/geometric/cell-geometrics.h b/include/gds-render/geometric/cell-geometrics.h index 6226bf8..639abde 100644 --- a/include/gds-render/geometric/cell-geometrics.h +++ b/include/gds-render/geometric/cell-geometrics.h @@ -35,10 +35,16 @@ #include /** - * @brief calculate_cell_bounding_box Calculate bounding box of gds cell - * @param box Resulting boundig box. Will be uüdated and not overwritten + * @brief Calculate bounding box of a gds cell. + * + * This function updates a given bounding box with the dimensions of a + * gds_cell. Please note that the handling of path miter points is not complete yet. + * If a path object is the putmost object of your cell at any edge, + * the resulting bounding box might be the wrong size. + * + * @param box Resulting boundig box. Will be updated and not overwritten * @param cell Toplevel cell - * @warning Path handling not yet implemented correctly. + * @warning Handling of Path graphic objects not yet implemented correctly. */ void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell);