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

doxygen fixes

Browse source
This commit is contained in:
Joel Bodenmann 2013-11-10 21:30:56 +01:00
parent f73c1972ba
commit 48c2c7125b
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
include/gdisp/gdisp.h
View file

@ -145,7 +145,7 @@ extern GDisplay *GDISP;
*/ */
/** /**
* @brief The pixel format. * @brief The pixel format.
* @default It generally defaults to the hardware pixel format. * @details It generally defaults to the hardware pixel format.
* @note This doesn't need to match the hardware pixel format. * @note This doesn't need to match the hardware pixel format.
* It is definitely more efficient when it does. * It is definitely more efficient when it does.
* @note When GDISP_TOTAL_CONTROLLERS > 1, this must * @note When GDISP_TOTAL_CONTROLLERS > 1, this must
@ -232,7 +232,7 @@ GDisplay *gdispGetDisplay(unsigned display);
* value. * value.
* @note If a NULL is passed for the dispay this call is ignored. * @note If a NULL is passed for the dispay this call is ignored.
* *
* @param[in] display The display number (0..n) * @param[in] g The display number (0..n)
* *
* @api * @api
*/ */
@ -254,7 +254,7 @@ void gdispSetDisplay(GDisplay *g);
* Calling it again won't hurt though. * Calling it again won't hurt though.
* *
* *
* @param[in] display The display number (0..n) * @param[in] g The display number (0..n)
* *
* @api * @api
*/ */

9
include/gdisp/lld/gdisp_lld.h
View file

@ -16,7 +16,7 @@
#ifndef _GDISP_LLD_H #ifndef _GDISP_LLD_H
#define _GDISP_LLD_H #define _GDISP_LLD_H
#if GFX_USE_GDISP || defined(__DOXYGEN__) #if GFX_USE_GDISP // || defined(__DOXYGEN__)
/*===========================================================================*/ /*===========================================================================*/
/* Error checks. */ /* Error checks. */
@ -277,8 +277,9 @@ struct GDisplay {
* @pre GDISP_HARDWARE_STREAM_WRITE is TRUE * @pre GDISP_HARDWARE_STREAM_WRITE is TRUE
* *
* @param[in] g The driver structure * @param[in] g The driver structure
* @param[in] g->p.x,g->p.y The window position *
* @param[in] g->p.cx,g->p.cy The window size * @note g->p.x,g->p.y The window position
* @note g->p.cx,g->p.cy The window size
* *
* @note The parameter variables must not be altered by the driver. * @note The parameter variables must not be altered by the driver.
* @note Streaming operations that wrap the defined window have * @note Streaming operations that wrap the defined window have
@ -292,8 +293,8 @@ struct GDisplay {
* @pre GDISP_HARDWARE_STREAM_WRITE is TRUE * @pre GDISP_HARDWARE_STREAM_WRITE is TRUE
* *
* @param[in] g The driver structure * @param[in] g The driver structure
* @param[in] g->p.color The color to display at the curent position
* *
* @note g->p.color The color to display at the curent position
* @note The parameter variables must not be altered by the driver. * @note The parameter variables must not be altered by the driver.
*/ */
LLDSPEC void gdisp_lld_write_color(GDisplay *g); LLDSPEC void gdisp_lld_write_color(GDisplay *g);

1
include/ginput/mouse.h
View file

@ -112,7 +112,6 @@ extern "C" {
* @return A pointer to the display * @return A pointer to the display
* *
* @param[in] instance The ID of the mouse input instance * @param[in] instance The ID of the mouse input instance
* @param[in] g The GDisplay to which this mouse belongs
*/ */
GDisplay *ginputGetMouseDisplay(uint16_t instance); GDisplay *ginputGetMouseDisplay(uint16_t instance);