uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

moar doxygen fixes

Browse Source
This commit is contained in:
Joel Bodenmann 2012-11-02 20:26:06 +01:00
parent 397b5074e8
commit 1294824260
12 changed files with 74 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/gdisp/Nokia6610/gdisp_lld.c
View File

@ -448,7 +448,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__) #if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__)
/** /**
* @brief Driver Control * @brief Driver Control
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t

2
drivers/gdisp/S6D1121/gdisp_lld.c
View File

@ -411,7 +411,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__) #if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__)
/** /**
* @brief Driver Control * @brief Driver Control
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t

2
drivers/gdisp/SSD1289/gdisp_lld.c
View File

@ -385,7 +385,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__) #if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__)
/** /**
* @brief Driver Control * @brief Driver Control
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t

2
drivers/gdisp/SSD1963/gdisp_lld.c
View File

@ -511,7 +511,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__) #if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__)
/** /**
* @brief Driver Control * @brief Driver Control
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t

2
drivers/touchpad/XPT2046/touchpad_lld.c
View File

@ -67,6 +67,8 @@
/** /**
* @brief Low level Touchpad driver initialization. * @brief Low level Touchpad driver initialization.
* *
* @param[in] tp The touchpad driver struct
*
* @notapi * @notapi
*/ */
void tp_lld_init(const TOUCHPADDriver *tp) { void tp_lld_init(const TOUCHPADDriver *tp) {

6
include/gdisp_lld.h
View File

@ -146,7 +146,7 @@
/** /**
* @brief Driver Control Constants * @brief Driver Control Constants
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t
@ -166,7 +166,7 @@
/** /**
* @brief Driver Query Constants * @brief Driver Query Constants
* @detail Unsupported query codes return (void *)-1. * @details Unsupported query codes return (void *)-1.
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note The result should be typecast the required type. * @note The result should be typecast the required type.
* @note GDISP_QUERY_WIDTH - Gets the width of the screen * @note GDISP_QUERY_WIDTH - Gets the width of the screen
@ -398,7 +398,7 @@
* GDISP_PIXELFORMAT_RGB666 * GDISP_PIXELFORMAT_RGB666
* GDISP_PIXELFORMAT_CUSTOM * GDISP_PIXELFORMAT_CUSTOM
* @note If you use GDISP_PIXELFORMAT_CUSTOM and packed bit fills * @note If you use GDISP_PIXELFORMAT_CUSTOM and packed bit fills
* you need to also define @P gdispPackPixels(buf,cx,x,y,c) * you need to also define @p gdispPackPixels(buf,cx,x,y,c)
* @note If you are using GDISP_HARDWARE_BITFILLS = FALSE then the pixel * @note If you are using GDISP_HARDWARE_BITFILLS = FALSE then the pixel
* format must not be a packed format as the software blit does * format must not be a packed format as the software blit does
* not support packed pixels * not support packed pixels

2
include/touchpad.h
View File

@ -22,7 +22,7 @@
* @file touchpad.h * @file touchpad.h
* @brief TOUCHPAD Touchpad Driver subsystem header file. * @brief TOUCHPAD Touchpad Driver subsystem header file.
* *
* @addgroup TOUCHPAD * @addtogroup TOUCHPAD
* @{ * @{
*/ */
#ifndef _TOUCHPAD_H #ifndef _TOUCHPAD_H

2
include/touchpad_lld.h
View File

@ -22,7 +22,7 @@
* @file touchpad_lld.h * @file touchpad_lld.h
* @brief TOUCHPAD Driver subsystem low level driver header. * @brief TOUCHPAD Driver subsystem low level driver header.
* *
* @addgroup TOUCHPAD * @addtogroup TOUCHPAD
* @{ * @{
*/ */

93
src/gdisp.c
View File

@ -144,6 +144,8 @@
* @note This function is NOT currently implicitly invoked by @p halInit(). * @note This function is NOT currently implicitly invoked by @p halInit().
* It must be called manually. * It must be called manually.
* *
* @return True if succeeded, False otherwise
*
* @init * @init
*/ */
bool_t gdispInit(void) { bool_t gdispInit(void) {
@ -192,7 +194,9 @@
/** /**
* @brief Test if the GDISP engine is currently drawing. * @brief Test if the GDISP engine is currently drawing.
* @note This function will always return FALSE if * @note This function will always return FALSE if
* GDISP_NEED_ASYNC is not defined. * GDISP_NEED_ASYNC is not defined.
*
* @return TRUE if gdisp is busy, FALSE otherwise
* *
* @init * @init
*/ */
@ -280,24 +284,12 @@
} }
#endif #endif
/**
* @brief Draw a dashed line.
* @pre The GDISP unit must be in powerOn or powerSleep mode.
*
* @param[in] x0,y0 The start position
* @param[in] x1,y1 The end position
* @param[in] length The length of the dash
* @param[in] color The color of the dashed line
*
* @api
*/
#if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__) #if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__)
/** /**
* @brief Fill an area with a color. * @brief Fill an area with a color.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x0,y0 The start position * @param[in] x,y The start position
* @param[in] cx,cy The size of the box (outside dimensions) * @param[in] cx,cy The size of the box (outside dimensions)
* @param[in] color The color to use * @param[in] color The color to use
* *
@ -332,9 +324,11 @@
* or at least retained until this call has finished the blit. You can * or at least retained until this call has finished the blit. You can
* tell when all graphics drawing is finished by @p gdispIsBusy() going FALSE. * tell when all graphics drawing is finished by @p gdispIsBusy() going FALSE.
* *
* @param[in] x,y The start position * @param[in] x,y The start position
* @param[in] cx,cy The size of the filled area * @param[in] cx,cy The size of the filled area
* @param[in] buffer The bitmap in the driver's pixel format. * @param[in] srcx,srcy I've no idea
* @param[in] srccx Really, I've no fucking idea
* @param[in] buffer The bitmap in the driver's pixel format
* *
* @api * @api
*/ */
@ -389,7 +383,7 @@
* @brief Draw a circle. * @brief Draw a circle.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x0,y0 The center of the circle * @param[in] x,y The center of the circle
* @param[in] radius The radius of the circle * @param[in] radius The radius of the circle
* @param[in] color The color to use * @param[in] color The color to use
* *
@ -416,7 +410,7 @@
* @brief Draw a filled circle. * @brief Draw a filled circle.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x0,y0 The center of the circle * @param[in] x,y The center of the circle
* @param[in] radius The radius of the circle * @param[in] radius The radius of the circle
* @param[in] color The color to use * @param[in] color The color to use
* *
@ -443,7 +437,7 @@
* @brief Draw an ellipse. * @brief Draw an ellipse.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x0,y0 The center of the ellipse * @param[in] x,y The center of the ellipse
* @param[in] a,b The dimensions of the ellipse * @param[in] a,b The dimensions of the ellipse
* @param[in] color The color to use * @param[in] color The color to use
* *
@ -471,7 +465,7 @@
* @brief Draw a filled ellipse. * @brief Draw a filled ellipse.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x0,y0 The center of the ellipse * @param[in] x,y The center of the ellipse
* @param[in] a,b The dimensions of the ellipse * @param[in] a,b The dimensions of the ellipse
* @param[in] color The color to use * @param[in] color The color to use
* *
@ -620,9 +614,10 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r
* @brief Draw a text character. * @brief Draw a text character.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x,y The position for the text * @param[in] x,y The position for the text
* @param[in] c The character to draw * @param[in] c The character to draw
* @param[in] color The color to use * @param[in] font The font to use
* @param[in] color The color to use
* *
* @api * @api
*/ */
@ -648,10 +643,11 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r
* @brief Draw a text character with a filled background. * @brief Draw a text character with a filled background.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x,y The position for the text * @param[in] x,y The position for the text
* @param[in] c The character to draw * @param[in] c The character to draw
* @param[in] color The color to use * @param[in] font The font to use
* @param[in] bgcolor The background color to use * @param[in] color The color to use
* @param[in] bgcolor The background color to use
* *
* @api * @api
*/ */
@ -732,7 +728,8 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r
* @note Depending on the hardware implementation this function may not * @note Depending on the hardware implementation this function may not
* support some codes. They will be ignored. * support some codes. They will be ignored.
* *
* @param[in] powerMode The power mode to use * @param[in] what what you want to control
* @param[in] value The value to be assigned
* *
* @api * @api
*/ */
@ -819,9 +816,10 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) {
* @brief Draw a text string. * @brief Draw a text string.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x,y The position for the text * @param[in] x,y The position for the text
* @param[in] str The string to draw * @param[in] font The font to use
* @param[in] color The color to use * @param[in] str The string to draw
* @param[in] color The color to use
* *
* @api * @api
*/ */
@ -861,10 +859,11 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) {
* @brief Draw a text string. * @brief Draw a text string.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x,y The position for the text * @param[in] x,y The position for the text
* @param[in] str The string to draw * @param[in] str The string to draw
* @param[in] color The color to use * @param[in] font The font to use
* @param[in] bgcolor The background color to use * @param[in] color The color to use
* @param[in] bgcolor The background color to use
* *
* @api * @api
*/ */
@ -906,10 +905,12 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) {
* @brief Draw a text string verticly centered within the specified box. * @brief Draw a text string verticly centered within the specified box.
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* *
* @param[in] x,y The position for the text (need to define top-right or base-line - check code) * @param[in] x,y The position for the text (need to define top-right or base-line - check code)
* @param[in] str The string to draw * @param[in] cx,cy The width and height of the box
* @param[in] color The color to use * @param[in] str The string to draw
* @param[in] justify Justify the text left, center or right within the box * @param[in] font The font to use
* @param[in] color The color to use
* @param[in] justify Justify the text left, center or right within the box
* *
* @api * @api
*/ */
@ -1038,11 +1039,13 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) {
* @pre The GDISP unit must be in powerOn or powerSleep mode. * @pre The GDISP unit must be in powerOn or powerSleep mode.
* @note The entire box is filled * @note The entire box is filled
* *
* @param[in] x,y The position for the text (need to define top-right or base-line - check code) * @param[in] x,y The position for the text (need to define top-right or base-line - check code)
* @param[in] str The string to draw * @param[in] cx,cy The width and height of the box
* @param[in] color The color to use * @param[in] str The string to draw
* @param[in] bgcolor The background color to use * @param[in] font The font to use
* @param[in] justify Justify the text left, center or right within the box * @param[in] color The color to use
* @param[in] bgcolor The background color to use
* @param[in] justify Justify the text left, center or right within the box
* *
* @api * @api
*/ */

4
src/touchpad.c
View File

@ -21,7 +21,7 @@
* @file touchpad.c * @file touchpad.c
* @brief Touchpad Driver code. * @brief Touchpad Driver code.
* *
* @addgroup TOUCHPAD * @addtogroup TOUCHPAD
* @{ * @{
*/ */
#include "ch.h" #include "ch.h"
@ -126,6 +126,8 @@ static void _tpDrawCross(uint16_t x, uint16_t y) {
* @note This function is NOT currently implicitly invoked by @p halInit(). * @note This function is NOT currently implicitly invoked by @p halInit().
* It must be called manually. * It must be called manually.
* *
* @param[in] tp The touchpad driver struct
*
* @api * @api
*/ */
void tpInit(const TOUCHPADDriver *tp) { void tpInit(const TOUCHPADDriver *tp) {

18
templates/gdispXXXXX/gdisp_lld.c
View File

@ -338,9 +338,10 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
* @brief Draw a character using a transparent background. * @brief Draw a character using a transparent background.
* @note Optional - The high level driver can emulate using software. * @note Optional - The high level driver can emulate using software.
* *
* @param[in] x, y The top-left corner of the text * @param[in] x, y The top-left corner of the text
* @param[in] c The character to print * @param[in] c The character to print
* @param[in] color The color of the character * @param[in] font The font to use
* @param[in] color The color of the character
* *
* @notapi * @notapi
*/ */
@ -357,10 +358,11 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
* @brief Draw a character using a filled background. * @brief Draw a character using a filled background.
* @note Optional - The high level driver can emulate using software. * @note Optional - The high level driver can emulate using software.
* *
* @param[in] x, y The top-left corner of the text * @param[in] x, y The top-left corner of the text
* @param[in] c The character to print * @param[in] c The character to print
* @param[in] color The color of the character * @param[in] font The font to use
* @param[in] bgcolor The background color * @param[in] color The color of the character
* @param[in] bgcolor The background color
* *
* @notapi * @notapi
*/ */
@ -420,7 +422,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__) #if (GDISP_NEED_CONTROL && GDISP_HARDWARE_CONTROL) || defined(__DOXYGEN__)
/** /**
* @brief Driver Control * @brief Driver Control
* @detail Unsupported control codes are ignored. * @details Unsupported control codes are ignored.
* @note The value parameter should always be typecast to (void *). * @note The value parameter should always be typecast to (void *).
* @note There are some predefined and some specific to the low level driver. * @note There are some predefined and some specific to the low level driver.
* @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t

2
templates/touchpadXXXXX/touchpad_lld.c
View File

@ -71,6 +71,8 @@
/** /**
* @brief Low level Touchpad driver initialization. * @brief Low level Touchpad driver initialization.
* *
* @param[in] tp The touchpad driver struct
*
* @notapi * @notapi
*/ */
void tp_lld_init(TOUCHPADDriver *tp) { void tp_lld_init(TOUCHPADDriver *tp) {