Doxygen: Update calculate_cell_bounding_box()
* Add note about problematic behaviour * Fix typos
This commit is contained in:
parent
ceeb67355d
commit
232d025211
@ -35,10 +35,16 @@
|
|||||||
#include <gds-render/gds-utils/gds-types.h>
|
#include <gds-render/gds-utils/gds-types.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief calculate_cell_bounding_box Calculate bounding box of gds cell
|
* @brief Calculate bounding box of a gds cell.
|
||||||
* @param box Resulting boundig box. Will be uüdated and not overwritten
|
*
|
||||||
|
* 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
|
* @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);
|
void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell);
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user