From 1294824260eccfc79c449de103fbafd73d5670a3 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Fri, 2 Nov 2012 20:26:06 +0100 Subject: [PATCH] moar doxygen fixes --- drivers/gdisp/Nokia6610/gdisp_lld.c | 2 +- drivers/gdisp/S6D1121/gdisp_lld.c | 2 +- drivers/gdisp/SSD1289/gdisp_lld.c | 2 +- drivers/gdisp/SSD1963/gdisp_lld.c | 2 +- drivers/touchpad/XPT2046/touchpad_lld.c | 2 + include/gdisp_lld.h | 6 +- include/touchpad.h | 2 +- include/touchpad_lld.h | 2 +- src/gdisp.c | 93 +++++++++++++------------ src/touchpad.c | 4 +- templates/gdispXXXXX/gdisp_lld.c | 18 ++--- templates/touchpadXXXXX/touchpad_lld.c | 2 + 12 files changed, 74 insertions(+), 63 deletions(-) diff --git a/drivers/gdisp/Nokia6610/gdisp_lld.c b/drivers/gdisp/Nokia6610/gdisp_lld.c index 23b0d1a7..e3da570e 100644 --- a/drivers/gdisp/Nokia6610/gdisp_lld.c +++ b/drivers/gdisp/Nokia6610/gdisp_lld.c @@ -448,7 +448,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) { #if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__) /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t diff --git a/drivers/gdisp/S6D1121/gdisp_lld.c b/drivers/gdisp/S6D1121/gdisp_lld.c index e199f58f..6a8b4aed 100644 --- a/drivers/gdisp/S6D1121/gdisp_lld.c +++ b/drivers/gdisp/S6D1121/gdisp_lld.c @@ -411,7 +411,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) { #if GDISP_HARDWARE_CONTROL || defined(__DOXYGEN__) /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t diff --git a/drivers/gdisp/SSD1289/gdisp_lld.c b/drivers/gdisp/SSD1289/gdisp_lld.c index 321923e0..00bb92cf 100644 --- a/drivers/gdisp/SSD1289/gdisp_lld.c +++ b/drivers/gdisp/SSD1289/gdisp_lld.c @@ -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__) /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t diff --git a/drivers/gdisp/SSD1963/gdisp_lld.c b/drivers/gdisp/SSD1963/gdisp_lld.c index e54e889d..d42bfd18 100644 --- a/drivers/gdisp/SSD1963/gdisp_lld.c +++ b/drivers/gdisp/SSD1963/gdisp_lld.c @@ -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__) /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t diff --git a/drivers/touchpad/XPT2046/touchpad_lld.c b/drivers/touchpad/XPT2046/touchpad_lld.c index 4640ca8d..cb413fdf 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld.c +++ b/drivers/touchpad/XPT2046/touchpad_lld.c @@ -67,6 +67,8 @@ /** * @brief Low level Touchpad driver initialization. * + * @param[in] tp The touchpad driver struct + * * @notapi */ void tp_lld_init(const TOUCHPADDriver *tp) { diff --git a/include/gdisp_lld.h b/include/gdisp_lld.h index 6dd826d9..966a8f54 100644 --- a/include/gdisp_lld.h +++ b/include/gdisp_lld.h @@ -146,7 +146,7 @@ /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t @@ -166,7 +166,7 @@ /** * @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 The result should be typecast the required type. * @note GDISP_QUERY_WIDTH - Gets the width of the screen @@ -398,7 +398,7 @@ * GDISP_PIXELFORMAT_RGB666 * GDISP_PIXELFORMAT_CUSTOM * @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 * format must not be a packed format as the software blit does * not support packed pixels diff --git a/include/touchpad.h b/include/touchpad.h index 1db5ac98..b6aa2589 100644 --- a/include/touchpad.h +++ b/include/touchpad.h @@ -22,7 +22,7 @@ * @file touchpad.h * @brief TOUCHPAD Touchpad Driver subsystem header file. * - * @addgroup TOUCHPAD + * @addtogroup TOUCHPAD * @{ */ #ifndef _TOUCHPAD_H diff --git a/include/touchpad_lld.h b/include/touchpad_lld.h index c73591c7..ab19cd97 100644 --- a/include/touchpad_lld.h +++ b/include/touchpad_lld.h @@ -22,7 +22,7 @@ * @file touchpad_lld.h * @brief TOUCHPAD Driver subsystem low level driver header. * - * @addgroup TOUCHPAD + * @addtogroup TOUCHPAD * @{ */ diff --git a/src/gdisp.c b/src/gdisp.c index 5a3aff13..af95f632 100644 --- a/src/gdisp.c +++ b/src/gdisp.c @@ -144,6 +144,8 @@ * @note This function is NOT currently implicitly invoked by @p halInit(). * It must be called manually. * + * @return True if succeeded, False otherwise + * * @init */ bool_t gdispInit(void) { @@ -192,7 +194,9 @@ /** * @brief Test if the GDISP engine is currently drawing. * @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 */ @@ -280,24 +284,12 @@ } #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__) /** * @brief Fill an area with a color. * @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] color The color to use * @@ -332,9 +324,11 @@ * 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. * - * @param[in] x,y The start position - * @param[in] cx,cy The size of the filled area - * @param[in] buffer The bitmap in the driver's pixel format. + * @param[in] x,y The start position + * @param[in] cx,cy The size of the filled area + * @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 */ @@ -389,7 +383,7 @@ * @brief Draw a circle. * @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] color The color to use * @@ -416,7 +410,7 @@ * @brief Draw a filled circle. * @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] color The color to use * @@ -443,7 +437,7 @@ * @brief Draw an ellipse. * @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] color The color to use * @@ -471,7 +465,7 @@ * @brief Draw a filled ellipse. * @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] 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. * @pre The GDISP unit must be in powerOn or powerSleep mode. * - * @param[in] x,y The position for the text - * @param[in] c The character to draw - * @param[in] color The color to use + * @param[in] x,y The position for the text + * @param[in] c The character to draw + * @param[in] font The font to use + * @param[in] color The color to use * * @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. * @pre The GDISP unit must be in powerOn or powerSleep mode. * - * @param[in] x,y The position for the text - * @param[in] c The character to draw - * @param[in] color The color to use - * @param[in] bgcolor The background color to use + * @param[in] x,y The position for the text + * @param[in] c The character to draw + * @param[in] font The font to use + * @param[in] color The color to use + * @param[in] bgcolor The background color to use * * @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 * 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 */ @@ -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. * @pre The GDISP unit must be in powerOn or powerSleep mode. * - * @param[in] x,y The position for the text - * @param[in] str The string to draw - * @param[in] color The color to use + * @param[in] x,y The position for the text + * @param[in] font The font to use + * @param[in] str The string to draw + * @param[in] color The color to use * * @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. * @pre The GDISP unit must be in powerOn or powerSleep mode. * - * @param[in] x,y The position for the text - * @param[in] str The string to draw - * @param[in] color The color to use - * @param[in] bgcolor The background color to use + * @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] bgcolor The background color to use * * @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. * @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] str The string to draw - * @param[in] color The color to use - * @param[in] justify Justify the text left, center or right within the box + * @param[in] x,y The position for the text (need to define top-right or base-line - check code) + * @param[in] cx,cy The width and height of the box + * @param[in] str The string to draw + * @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 */ @@ -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. * @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] str The string to draw - * @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 + * @param[in] x,y The position for the text (need to define top-right or base-line - check code) + * @param[in] cx,cy The width and height of the box + * @param[in] str The string to draw + * @param[in] font The font to use + * @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 */ diff --git a/src/touchpad.c b/src/touchpad.c index bf6936d7..7559d6d3 100644 --- a/src/touchpad.c +++ b/src/touchpad.c @@ -21,7 +21,7 @@ * @file touchpad.c * @brief Touchpad Driver code. * - * @addgroup TOUCHPAD + * @addtogroup TOUCHPAD * @{ */ #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(). * It must be called manually. * + * @param[in] tp The touchpad driver struct + * * @api */ void tpInit(const TOUCHPADDriver *tp) { diff --git a/templates/gdispXXXXX/gdisp_lld.c b/templates/gdispXXXXX/gdisp_lld.c index 09912d9f..205b7fa2 100644 --- a/templates/gdispXXXXX/gdisp_lld.c +++ b/templates/gdispXXXXX/gdisp_lld.c @@ -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. * @note Optional - The high level driver can emulate using software. * - * @param[in] x, y The top-left corner of the text - * @param[in] c The character to print - * @param[in] color The color of the character + * @param[in] x, y The top-left corner of the text + * @param[in] c The character to print + * @param[in] font The font to use + * @param[in] color The color of the character * * @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. * @note Optional - The high level driver can emulate using software. * - * @param[in] x, y The top-left corner of the text - * @param[in] c The character to print - * @param[in] color The color of the character - * @param[in] bgcolor The background color + * @param[in] x, y The top-left corner of the text + * @param[in] c The character to print + * @param[in] font The font to use + * @param[in] color The color of the character + * @param[in] bgcolor The background color * * @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__) /** * @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 There are some predefined and some specific to the low level driver. * @note GDISP_CONTROL_POWER - Takes a gdisp_powermode_t diff --git a/templates/touchpadXXXXX/touchpad_lld.c b/templates/touchpadXXXXX/touchpad_lld.c index 9bcae27d..bba9c71e 100644 --- a/templates/touchpadXXXXX/touchpad_lld.c +++ b/templates/touchpadXXXXX/touchpad_lld.c @@ -71,6 +71,8 @@ /** * @brief Low level Touchpad driver initialization. * + * @param[in] tp The touchpad driver struct + * * @notapi */ void tp_lld_init(TOUCHPADDriver *tp) {