From b7a89b2adaa9ee170d20a0454309ed204a6ffa39 Mon Sep 17 00:00:00 2001 From: inmarket Date: Mon, 29 Sep 2014 16:09:08 +1000 Subject: [PATCH] doxygen updates --- src/gdisp/gdisp_image_bmp.c | 2 +- src/gdisp/gdisp_image_gif.c | 2 +- src/gdisp/gdisp_image_jpg.c | 2 +- src/gdisp/gdisp_image_native.c | 2 +- src/gdisp/gdisp_image_png.c | 2 +- src/gdisp/sys_defs.h | 12 ++++++++++++ src/gfile/sys_defs.h | 14 +++++++------- src/gos/gfx_freertos.h | 2 +- src/gos/gfx_win32.c | 2 +- src/gos/gfx_win32.h | 2 +- 10 files changed, 27 insertions(+), 15 deletions(-) diff --git a/src/gdisp/gdisp_image_bmp.c b/src/gdisp/gdisp_image_bmp.c index 8ff40ca0..d4507ee2 100644 --- a/src/gdisp/gdisp_image_bmp.c +++ b/src/gdisp/gdisp_image_bmp.c @@ -6,7 +6,7 @@ */ /** - * @file src/gdisp/image_bmp.c + * @file src/gdisp/gdisp_image_bmp.c * @brief GDISP native image code. * * @defgroup Image Image diff --git a/src/gdisp/gdisp_image_gif.c b/src/gdisp/gdisp_image_gif.c index 06f4ef6a..8ea9beb2 100644 --- a/src/gdisp/gdisp_image_gif.c +++ b/src/gdisp/gdisp_image_gif.c @@ -6,7 +6,7 @@ */ /** - * @file src/gdisp/image_gif.c + * @file src/gdisp/gdisp_image_gif.c * @brief GDISP native image code. * * @defgroup Image Image diff --git a/src/gdisp/gdisp_image_jpg.c b/src/gdisp/gdisp_image_jpg.c index 2f6a9392..f20884bc 100644 --- a/src/gdisp/gdisp_image_jpg.c +++ b/src/gdisp/gdisp_image_jpg.c @@ -6,7 +6,7 @@ */ /** - * @file src/gdisp/image_jpg.c + * @file src/gdisp/gdisp_image_jpg.c * @brief GDISP native image code. */ #include "gfx.h" diff --git a/src/gdisp/gdisp_image_native.c b/src/gdisp/gdisp_image_native.c index 81344642..21dcb0fc 100644 --- a/src/gdisp/gdisp_image_native.c +++ b/src/gdisp/gdisp_image_native.c @@ -6,7 +6,7 @@ */ /** - * @file src/gdisp/image_native.c + * @file src/gdisp/gdisp_image_native.c * @brief GDISP native image code. */ #include "gfx.h" diff --git a/src/gdisp/gdisp_image_png.c b/src/gdisp/gdisp_image_png.c index f35174d9..5d2c1450 100644 --- a/src/gdisp/gdisp_image_png.c +++ b/src/gdisp/gdisp_image_png.c @@ -6,7 +6,7 @@ */ /** - * @file src/gdisp/image_png.c + * @file src/gdisp/gdisp_image_png.c * @brief GDISP native image code. */ #include "gfx.h" diff --git a/src/gdisp/sys_defs.h b/src/gdisp/sys_defs.h index 35844e2d..6ebfe8b5 100644 --- a/src/gdisp/sys_defs.h +++ b/src/gdisp/sys_defs.h @@ -250,6 +250,8 @@ unsigned gdispGetDisplayCount(void); * * @param[in] g The display to use * + * @return The width of the display + * * @api */ coord_t gdispGGetWidth(GDisplay *g); @@ -260,6 +262,8 @@ coord_t gdispGGetWidth(GDisplay *g); * * @param[in] g The display to use * + * @return The height of the display + * * @api */ coord_t gdispGGetHeight(GDisplay *g); @@ -270,6 +274,8 @@ coord_t gdispGGetHeight(GDisplay *g); * * @param[in] g The display to use * + * @return The current power mode + * * @api */ powermode_t gdispGGetPowerMode(GDisplay *g); @@ -280,6 +286,8 @@ powermode_t gdispGGetPowerMode(GDisplay *g); * * @param[in] g The display to use * + * @return The current orientation + * * @api */ orientation_t gdispGGetOrientation(GDisplay *g); @@ -290,6 +298,8 @@ orientation_t gdispGGetOrientation(GDisplay *g); * * @param[in] g The display to use * + * @return The current backlight value + * * @api */ uint8_t gdispGGetBacklight(GDisplay *g); @@ -300,6 +310,8 @@ uint8_t gdispGGetBacklight(GDisplay *g); * * @param[in] g The display to use * + * @return The current contrast value + * * @api */ uint8_t gdispGGetContrast(GDisplay *g); diff --git a/src/gfile/sys_defs.h b/src/gfile/sys_defs.h index 5a2d9845..2c475b40 100644 --- a/src/gfile/sys_defs.h +++ b/src/gfile/sys_defs.h @@ -103,21 +103,21 @@ extern "C" { * @return Valid GFILE on success, 0 otherwise * * @note The modes follow the c library fopen() standard. - * The valid modes are:
+ * The valid modes are: *
- * THe following flags can also be added to the above modes:
+ * + * The following flags can also be added to the above modes:
*