From b7a89b2adaa9ee170d20a0454309ed204a6ffa39 Mon Sep 17 00:00:00 2001
From: inmarket <andrewh@inmarket.com.au>
Date: Mon, 29 Sep 2014 16:09:08 +1000
Subject: 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:<br/>
+ * The valid modes are:
* <ul><li>r - Open for read, the file must exist</li>
* <li>w - Open for write, the file is truncated if it exists</li>
* <li>wx - Open for write, the file must not exist</li>
* <li>a - Open for append, the file is truncated if it exists</li>
* <li>ax - Open for append, the file must not exists</li>
- * </ul><br/>
- * THe following flags can also be added to the above modes:<br/>
+ * </ul>
+ * The following flags can also be added to the above modes:<br/>
* <ul><li>+ - Open for both read and write</li>
* <li>b - Open as a binary file rather than a text file</li>
- * <ul>
+ * </ul>
* @note Not all file-systems support all modes. For example, write
* is not available with the ROM file-system. Similarly few platforms
* distinguish between binary and text files.
- * @note Even though binary vs text is relevant only for a small number of platforms
+ * @note Even though binary vs. text is relevant only for a small number of platforms
* the "b" flag should always be specified for binary files such as images.
* This ensures portability to other platforms. The extra flag will be ignored
* on platforms where it is not relevant.
@@ -346,8 +346,8 @@ extern "C" {
/**
* @brief Open file from a null terminated C string
*
- * @param[in] memptr The pointer to the string or string buffer
- * @param[in] mode The mode.
+ * @param[in] str The pointer to the string or string buffer
+ * @param[in] mode The mode
*
* @return Valid GFILE on success, 0 otherwise
*
diff --git a/src/gos/gfx_freertos.h b/src/gos/gfx_freertos.h
index 34ef548e..57f9b8bd 100644
--- a/src/gos/gfx_freertos.h
+++ b/src/gos/gfx_freertos.h
@@ -6,7 +6,7 @@
*/
/**
- * @file src/gos/freertos.h
+ * @file src/gos/gfx_freertos.h
* @brief GOS - Operating System Support header file for FreeRTOS.
*/
diff --git a/src/gos/gfx_win32.c b/src/gos/gfx_win32.c
index ffa7fac5..5d33314f 100644
--- a/src/gos/gfx_win32.c
+++ b/src/gos/gfx_win32.c
@@ -6,7 +6,7 @@
*/
/**
- * @file src/gos/win32.c
+ * @file src/gos/gfx_win32.c
* @brief GOS Win32 Operating System support.
*/
#include "gfx.h"
diff --git a/src/gos/gfx_win32.h b/src/gos/gfx_win32.h
index 4a198200..5e924a44 100644
--- a/src/gos/gfx_win32.h
+++ b/src/gos/gfx_win32.h
@@ -6,7 +6,7 @@
*/
/**
- * @file src/gos/win32.h
+ * @file src/gos/gfx_win32.h
* @brief GOS - Operating System Support header file for WIN32.
*/
--
cgit v1.2.3