From 1294824260eccfc79c449de103fbafd73d5670a3 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Fri, 2 Nov 2012 20:26:06 +0100 Subject: moar doxygen fixes --- src/gdisp.c | 93 +++++++++++++++++++++++++++++++------------------------------ 1 file changed, 48 insertions(+), 45 deletions(-) (limited to 'src/gdisp.c') 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 */ -- cgit v1.2.3 From db0c770ca0c7e04a86075c4dfc073eaf683ff5f7 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 3 Nov 2012 02:56:59 +0100 Subject: even more doxygen... --- src/gdisp.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/gdisp.c') diff --git a/src/gdisp.c b/src/gdisp.c index af95f632..2d4e7f3e 100644 --- a/src/gdisp.c +++ b/src/gdisp.c @@ -19,7 +19,7 @@ */ /** - * @file gdisp.c + * @file src/gdisp.c * @brief GDISP Driver code. * * @addtogroup GDISP -- cgit v1.2.3 From ecc3989355ca70f7830fac00a37a1000da86b3ff Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 3 Nov 2012 03:01:13 +0100 Subject: and the final touch of doxygen... --- src/gdisp.c | 1 + 1 file changed, 1 insertion(+) (limited to 'src/gdisp.c') diff --git a/src/gdisp.c b/src/gdisp.c index 2d4e7f3e..80c2469c 100644 --- a/src/gdisp.c +++ b/src/gdisp.c @@ -693,6 +693,7 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r #if (GDISP_NEED_SCROLL && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Scroll vertically a section of the screen. + * @pre GDISP_NEED_SCROLL must be set to TRUE in halconf.h * @note Optional. * @note If lines is >= cy, it is equivelent to a area fill with bgcolor. * -- cgit v1.2.3 From fa5ea7915073d42992c0cf91de6d4733633e1535 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 3 Nov 2012 21:03:29 +0100 Subject: cleanup of doxygen --- src/gdisp.c | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'src/gdisp.c') diff --git a/src/gdisp.c b/src/gdisp.c index 80c2469c..35d778d3 100644 --- a/src/gdisp.c +++ b/src/gdisp.c @@ -212,7 +212,6 @@ #if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__) /** * @brief Clear the display to the specified color. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] color The color to use when clearing the screen * @@ -234,7 +233,6 @@ #if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__) /** * @brief Set a pixel in the specified color. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The position to set the pixel. * @param[in] color The color to use @@ -259,7 +257,6 @@ #if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__) /** * @brief Draw a 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 @@ -287,7 +284,6 @@ #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] x,y The start position * @param[in] cx,cy The size of the box (outside dimensions) @@ -315,7 +311,6 @@ #if GDISP_NEED_MULTITHREAD || defined(__DOXYGEN__) /** * @brief Fill an area using the supplied bitmap. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * @details The bitmap is in the pixel format specified by the low level driver * @note If a packed pixel format is used and the width doesn't * match a whole number of bytes, the next line will start on a @@ -355,7 +350,6 @@ #if (GDISP_NEED_CLIP && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Clip all drawing to the defined area. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The start position * @param[in] cx,cy The size of the clip area @@ -381,7 +375,6 @@ #if (GDISP_NEED_CIRCLE && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Draw a circle. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The center of the circle * @param[in] radius The radius of the circle @@ -408,7 +401,6 @@ #if (GDISP_NEED_CIRCLE && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Draw a filled circle. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The center of the circle * @param[in] radius The radius of the circle @@ -435,7 +427,6 @@ #if (GDISP_NEED_ELLIPSE && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Draw an ellipse. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The center of the ellipse * @param[in] a,b The dimensions of the ellipse @@ -463,7 +454,6 @@ #if (GDISP_NEED_ELLIPSE && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @brief Draw a filled ellipse. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The center of the ellipse * @param[in] a,b The dimensions of the ellipse @@ -491,7 +481,6 @@ #if (GDISP_NEED_ARC && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /* * @brief Draw an arc. - * @pre The GDISP must be in powerOn or powerSleep mode. * * @param[in] x0,y0 The center point * @param[in] radius The radius of the arc @@ -522,7 +511,6 @@ #if (GDISP_NEED_ARC && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /* * @brief Draw a filled arc. - * @pre The GDISP must be in powerOn or powerSleep mode. * @note Not very efficient currently - does lots of overdrawing * * @param[in] x0,y0 The center point @@ -554,7 +542,6 @@ #if GDISP_NEED_ARC || defined(__DOXYGEN__) /** * @brief Draw a rectangular box with rounded corners - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The start position * @param[in] cx,cy The size of the box (outside dimensions) @@ -582,7 +569,6 @@ void gdispDrawRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r #if GDISP_NEED_ARC || defined(__DOXYGEN__) /** * @brief Draw a filled rectangular box with rounded corners - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The start position * @param[in] cx,cy The size of the box (outside dimensions) @@ -612,7 +598,6 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r #if (GDISP_NEED_TEXT && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @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 @@ -641,7 +626,6 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r #if (GDISP_NEED_TEXT && GDISP_NEED_MULTITHREAD) || defined(__DOXYGEN__) /** * @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 @@ -777,7 +761,6 @@ void gdispFillRoundedBox(coord_t x, coord_t y, coord_t cx, coord_t cy, coord_t r /** * @brief Draw a rectangular box. - * @pre The GDISP unit must be in powerOn or powerSleep mode. * * @param[in] x,y The start position * @param[in] cx,cy The size of the box (outside dimensions) @@ -815,7 +798,6 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_TEXT || defined(__DOXYGEN__) /** * @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] font The font to use @@ -858,7 +840,6 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_TEXT || defined(__DOXYGEN__) /** * @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 @@ -904,7 +885,6 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_TEXT || defined(__DOXYGEN__) /** * @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] cx,cy The width and height of the box @@ -1037,7 +1017,6 @@ void gdispDrawBox(coord_t x, coord_t y, coord_t cx, coord_t cy, color_t color) { #if GDISP_NEED_TEXT || defined(__DOXYGEN__) /** * @brief Draw a text string verticly centered within the specified box. The box background is filled with the specified background 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) -- cgit v1.2.3