mhu/gds-render
1
0
Fork 0
Code Issues 4 Pull Requests Releases 8 Wiki Activity

fix doxygen

Browse Source
This commit is contained in:
Mario Hüttel 2019-03-05 21:46:29 +01:00
parent 546332a9c2
commit 586339cac1
5 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doxygen/trigonometric.dox
View File

@ -2,7 +2,7 @@
/** /**
* @defgroup trigonometric Trigonometric Helper Functions * @defgroup trigonometric Trigonometric Helper Functions
* @description The trigonometric helper function will be used in future releases to pcalculate bounding boxes *
* @note Currently not in use! * The trigonometric helper function are used to calculate bounding boxes
* @warning Code is incomplete. DO NOT USE! * @warning Code is incomplete. Please double check forfunctionality!
*/ */

3
external-renderer.h
View File

@ -36,7 +36,8 @@
/** /**
* @brief function name expected to be found in external library. * @brief function name expected to be found in external library.
* @detail The function has to be defined as follows: *
* The function has to be defined as follows:
* @code * @code
* int function_name(gds_cell *toplevel, GList *layer_info_list, char *output_file_name) * int function_name(gds_cell *toplevel, GList *layer_info_list, char *output_file_name)
* @endcode * @endcode

4
tree-renderer/tree-store.h
View File

@ -37,10 +37,10 @@
enum cell_store_columns { enum cell_store_columns {
CELL_SEL_LIBRARY = 0, CELL_SEL_LIBRARY = 0,
CELL_SEL_CELL, CELL_SEL_CELL,
CELL_SEL_CELL_COLOR, /**< Cell column color */ CELL_SEL_CELL_COLOR, /**< @brief Cell column color */
CELL_SEL_MODDATE, CELL_SEL_MODDATE,
CELL_SEL_ACCESSDATE, CELL_SEL_ACCESSDATE,
CELL_SEL_COLUMN_COUNT /**< Not a column. Used to determine count of coumns **/ CELL_SEL_COLUMN_COUNT /**< @brief Not a column. Used to determine count of columns */
}; };
struct tree_stores { struct tree_stores {

9
trigonometric/bounding-box.c
View File

@ -180,10 +180,11 @@ void bounding_box_update_point(union bounding_box *destination, conv_generic_to_
} }
/** /**
* @brief bounding_box_apply_transform * @brief Apply transformations onto bounding box.
* @param scale scaling factor * @param scale Scaling factor
* @param rotation roation of bounding box around the origin in degrees (counterclockwise) * @param rotation_deg Roation of bounding box around the origin in degrees (counterclockwise)
* @param box bounding box the operations should be applied to * @param flip_at_x Flip the boundig box on the x axis before rotating.
* @param box Bounding box the operations should be applied to.
*/ */
void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_at_x, union bounding_box *box) void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_at_x, union bounding_box *box)
{ {

6
trigonometric/cell-trigonometrics.c
View File

@ -38,9 +38,9 @@ static void convert_gds_point_to_2d_vector(struct gds_point *pt, struct vector_2
} }
/** /**
* @brief update_box_with_gfx * @brief Update the given bounding box with the bounding box of a graphics element.
* @param box * @param box box to update
* @param gfx_list * @param gfx Graphics element
*/ */
static void update_box_with_gfx(union bounding_box *box, struct gds_graphics *gfx) static void update_box_with_gfx(union bounding_box *box, struct gds_graphics *gfx)
{ {