From d4ba826474e0f1a9cb962101cca4f3c21b0e67f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Mon, 10 Dec 2018 19:36:00 +0100 Subject: [PATCH] Update doxygen --- doxygen/trigonometric.dox | 8 ++++++++ trigonometric/bounding-box.c | 7 +++++++ trigonometric/bounding-box.h | 8 ++++++++ trigonometric/vector-operations.c | 7 +++++++ trigonometric/vector-operations.h | 8 ++++++++ 5 files changed, 38 insertions(+) create mode 100644 doxygen/trigonometric.dox diff --git a/doxygen/trigonometric.dox b/doxygen/trigonometric.dox new file mode 100644 index 0000000..52819eb --- /dev/null +++ b/doxygen/trigonometric.dox @@ -0,0 +1,8 @@ +/* This file only contains help information for doxygen */ + +/** + * @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! + * @warning Code is incomplete. DO NOT USE! + */ diff --git a/trigonometric/bounding-box.c b/trigonometric/bounding-box.c index df8b873..3499ce4 100644 --- a/trigonometric/bounding-box.c +++ b/trigonometric/bounding-box.c @@ -23,6 +23,11 @@ * @author Mario Hüttel */ +/** + * @addtogroup trigonometric + * @{ + */ + #include #include "bounding-box.h" #include @@ -137,3 +142,5 @@ void bounding_box_update_point(union bounding_box *destination, conv_generic_to_ { } + +/** @} */ diff --git a/trigonometric/bounding-box.h b/trigonometric/bounding-box.h index d524c47..e3915e1 100644 --- a/trigonometric/bounding-box.h +++ b/trigonometric/bounding-box.h @@ -23,6 +23,11 @@ * @author Mario Hüttel */ +/** + * @addtogroup trigonometric + * @{ + */ + #ifndef _BOUNDING_BOX_H_ #define _BOUNDING_BOX_H_ #include @@ -42,4 +47,7 @@ void bounding_box_calculate_polygon(GList *vertices, conv_generic_to_vector_2d_t void bounding_box_update_box(union bounding_box *destination, union bounding_box *update); void bounding_box_prepare_empty(union bounding_box *box); void bounding_box_update_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt); + #endif /* _BOUNDING_BOX_H_ */ + +/** @} */ diff --git a/trigonometric/vector-operations.c b/trigonometric/vector-operations.c index bb741e5..4cdbca4 100644 --- a/trigonometric/vector-operations.c +++ b/trigonometric/vector-operations.c @@ -23,6 +23,11 @@ * @author Mario Hüttel */ +/** + * @addtogroup trigonometric + * @{ + */ + #include "vector-operations.h" #include #include @@ -141,3 +146,5 @@ void vector_2d_add(struct vector_2d *res, struct vector_2d *a, struct vector_2d res->y = a->y + b->y; } } + +/** @} */ diff --git a/trigonometric/vector-operations.h b/trigonometric/vector-operations.h index 3b98573..e4b04b7 100644 --- a/trigonometric/vector-operations.h +++ b/trigonometric/vector-operations.h @@ -23,6 +23,12 @@ * @author Mario Hüttel */ +/** + * @addtogroup trigonometric + * @{ + */ + + #ifndef _VECTOR_OPERATIONS_H_ #define _VECTOR_OPERATIONS_H_ @@ -48,3 +54,5 @@ void vector_2d_subtract(struct vector_2d *res, struct vector_2d *a, struct vecto void vector_2d_add(struct vector_2d *res, struct vector_2d *a, struct vector_2d *b); #endif /* _VECTOR_OPERATIONS_H_ */ + +/** @} */