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

Update doxygen

Browse Source
This commit is contained in:
Mario Hüttel 2018-12-10 19:36:00 +01:00
parent 8b1626c111
commit d4ba826474
5 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doxygen/trigonometric.dox Normal file
View File

@ -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!
*/

7
trigonometric/bounding-box.c
View File

@ -23,6 +23,11 @@
* @author Mario Hüttel <mario.huettel@gmx.net> * @author Mario Hüttel <mario.huettel@gmx.net>
*/ */
/**
* @addtogroup trigonometric
* @{
*/
#include <stdio.h> #include <stdio.h>
#include "bounding-box.h" #include "bounding-box.h"
#include <math.h> #include <math.h>
@ -137,3 +142,5 @@ void bounding_box_update_point(union bounding_box *destination, conv_generic_to_
{ {
} }
/** @} */

8
trigonometric/bounding-box.h
View File

@ -23,6 +23,11 @@
* @author Mario Hüttel <mario.huettel@gmx.net> * @author Mario Hüttel <mario.huettel@gmx.net>
*/ */
/**
* @addtogroup trigonometric
* @{
*/
#ifndef _BOUNDING_BOX_H_ #ifndef _BOUNDING_BOX_H_
#define _BOUNDING_BOX_H_ #define _BOUNDING_BOX_H_
#include <glib.h> #include <glib.h>
@ -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_update_box(union bounding_box *destination, union bounding_box *update);
void bounding_box_prepare_empty(union bounding_box *box); 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); void bounding_box_update_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt);
#endif /* _BOUNDING_BOX_H_ */ #endif /* _BOUNDING_BOX_H_ */
/** @} */

7
trigonometric/vector-operations.c
View File

@ -23,6 +23,11 @@
* @author Mario Hüttel <mario.huettel@gmx.net> * @author Mario Hüttel <mario.huettel@gmx.net>
*/ */
/**
* @addtogroup trigonometric
* @{
*/
#include "vector-operations.h" #include "vector-operations.h"
#include <math.h> #include <math.h>
#include <stdlib.h> #include <stdlib.h>
@ -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; res->y = a->y + b->y;
} }
} }
/** @} */

8
trigonometric/vector-operations.h
View File

@ -23,6 +23,12 @@
* @author Mario Hüttel <mario.huettel@gmx.net> * @author Mario Hüttel <mario.huettel@gmx.net>
*/ */
/**
* @addtogroup trigonometric
* @{
*/
#ifndef _VECTOR_OPERATIONS_H_ #ifndef _VECTOR_OPERATIONS_H_
#define _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); void vector_2d_add(struct vector_2d *res, struct vector_2d *a, struct vector_2d *b);
#endif /* _VECTOR_OPERATIONS_H_ */ #endif /* _VECTOR_OPERATIONS_H_ */
/** @} */