aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2013-11-10 21:30:56 +0100
committerJoel Bodenmann <joel@unormal.org>2013-11-10 21:30:56 +0100
commit48c2c7125bfa954277bca36e3d79786a6511db4a (patch)
tree170094fe07ffb749987064faa4d97b9737e0a4db /include
parentf73c1972ba1663badeeb2237d2985795cfa012f1 (diff)
downloaduGFX-48c2c7125bfa954277bca36e3d79786a6511db4a.tar.gz
uGFX-48c2c7125bfa954277bca36e3d79786a6511db4a.tar.bz2
uGFX-48c2c7125bfa954277bca36e3d79786a6511db4a.zip
doxygen fixes
Diffstat (limited to 'include')
-rw-r--r--include/gdisp/gdisp.h6
-rw-r--r--include/gdisp/lld/gdisp_lld.h9
-rw-r--r--include/ginput/mouse.h1
3 files changed, 8 insertions, 8 deletions
diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h
index 51415805..09dab71a 100644
--- a/include/gdisp/gdisp.h
+++ b/include/gdisp/gdisp.h
@@ -145,7 +145,7 @@ extern GDisplay *GDISP;
*/
/**
* @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.
* It is definitely more efficient when it does.
* @note When GDISP_TOTAL_CONTROLLERS > 1, this must
@@ -232,7 +232,7 @@ GDisplay *gdispGetDisplay(unsigned display);
* value.
* @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
*/
@@ -254,7 +254,7 @@ void gdispSetDisplay(GDisplay *g);
* Calling it again won't hurt though.
*
*
- * @param[in] display The display number (0..n)
+ * @param[in] g The display number (0..n)
*
* @api
*/
diff --git a/include/gdisp/lld/gdisp_lld.h b/include/gdisp/lld/gdisp_lld.h
index d928d83d..e48443e9 100644
--- a/include/gdisp/lld/gdisp_lld.h
+++ b/include/gdisp/lld/gdisp_lld.h
@@ -16,7 +16,7 @@
#ifndef _GDISP_LLD_H
#define _GDISP_LLD_H
-#if GFX_USE_GDISP || defined(__DOXYGEN__)
+#if GFX_USE_GDISP // || defined(__DOXYGEN__)
/*===========================================================================*/
/* Error checks. */
@@ -277,8 +277,9 @@ struct GDisplay {
* @pre GDISP_HARDWARE_STREAM_WRITE is TRUE
*
* @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 Streaming operations that wrap the defined window have
@@ -292,8 +293,8 @@ struct GDisplay {
* @pre GDISP_HARDWARE_STREAM_WRITE is TRUE
*
* @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.
*/
LLDSPEC void gdisp_lld_write_color(GDisplay *g);
diff --git a/include/ginput/mouse.h b/include/ginput/mouse.h
index aa9864a9..669eaec6 100644
--- a/include/ginput/mouse.h
+++ b/include/ginput/mouse.h
@@ -112,7 +112,6 @@ extern "C" {
* @return A pointer to the display
*
* @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);