From f8b0b63937fc9a5aac06f14c1dff10d57d0508cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Tue, 14 Jan 2020 18:39:00 +0100 Subject: [PATCH] Doxygen: Remove warning from uncommented code printf and place it in doxygen @warning tag instead --- geometric/bounding-box.c | 2 -- include/gds-render/geometric/bounding-box.h | 3 +++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/geometric/bounding-box.c b/geometric/bounding-box.c index a37dda4..44adbfc 100644 --- a/geometric/bounding-box.c +++ b/geometric/bounding-box.c @@ -151,8 +151,6 @@ void bounding_box_update_with_path(GList *vertices, double thickness, GList *vertex_iterator; struct vector_2d pt; - /* printf("Warning! Function %s not yet implemented correctly!\n", __func__); */ - if (!vertices || !box) return; diff --git a/include/gds-render/geometric/bounding-box.h b/include/gds-render/geometric/bounding-box.h index da16b1f..f363998 100644 --- a/include/gds-render/geometric/bounding-box.h +++ b/include/gds-render/geometric/bounding-box.h @@ -113,6 +113,9 @@ void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_a * @param thickness Thisckness of the path * @param conv_func Conversion function for vertices to vector_2d structs * @param box Bounding box to write results in. + * @warning This function is not yet implemented correctly. Miter points of paths are not taken into account. + * If a path is the outmost object of your cell _and_ it is not parallel to one of the coordinate axes, + * the calculated bounding box size might be off. In other cases it should be reasonable close to the real bounding box. */ void bounding_box_update_with_path(GList *vertices, double thickness, conv_generic_to_vector_2d_t conv_func, union bounding_box *box);