From 397b5074e8a8fae3dbfa52dd0ce62e4ccb2908dc Mon Sep 17 00:00:00 2001
From: Joel Bodenmann <joel@unormal.org>
Date: Fri, 2 Nov 2012 09:33:56 +0100
Subject: [PATCH] docs
---
drivers/touchpad/ADS7843/touchpad_lld.c | 2 ++
src/gwin.c | 1 +
templates/gdispXXXXX/gdisp_lld.c | 2 +-
templates/touchpadXXXXX/touchpad_lld.c | 4 ++++
4 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/drivers/touchpad/ADS7843/touchpad_lld.c b/drivers/touchpad/ADS7843/touchpad_lld.c
index 4640ca8d..02b501a2 100644
--- a/drivers/touchpad/ADS7843/touchpad_lld.c
+++ b/drivers/touchpad/ADS7843/touchpad_lld.c
@@ -67,6 +67,8 @@
/**
* @brief Low level Touchpad driver initialization.
*
+ * @param[in] The touchpad driver
+ *
* @notapi
*/
void tp_lld_init(const TOUCHPADDriver *tp) {
diff --git a/src/gwin.c b/src/gwin.c
index 1c987204..69750262 100644
--- a/src/gwin.c
+++ b/src/gwin.c
@@ -166,6 +166,7 @@ void gwinClear(GHandle gh) {
* @note May leave GDISP clipping to this window's dimensions
*
* @param[in] gh The window handle
+ * @param[in] x,y The coordinates of the pixel
*
* @api
*/
diff --git a/templates/gdispXXXXX/gdisp_lld.c b/templates/gdispXXXXX/gdisp_lld.c
index 5aa10f2d..09912d9f 100644
--- a/templates/gdispXXXXX/gdisp_lld.c
+++ b/templates/gdispXXXXX/gdisp_lld.c
@@ -507,7 +507,7 @@ void GDISP_LLD(drawpixel)(coord_t x, coord_t y, color_t color) {
#if (GDISP_NEED_QUERY && GDISP_HARDWARE_QUERY) || defined(__DOXYGEN__)
/**
* @brief Query a driver value.
- * @detail Typecase the result to the type you want.
+ * @details Typecase the result to the type you want.
* @note GDISP_QUERY_WIDTH - (coord_t) Gets the width of the screen
* GDISP_QUERY_HEIGHT - (coord_t) Gets the height of the screen
* GDISP_QUERY_POWER - (gdisp_powermode_t) Get the current powermode
diff --git a/templates/touchpadXXXXX/touchpad_lld.c b/templates/touchpadXXXXX/touchpad_lld.c
index 2fec6ade..9bcae27d 100644
--- a/templates/touchpadXXXXX/touchpad_lld.c
+++ b/templates/touchpadXXXXX/touchpad_lld.c
@@ -82,6 +82,8 @@ void tp_lld_init(TOUCHPADDriver *tp) {
/**
* @brief Reads out the X direction.
*
+ * @return The uncalibrated X coordinate
+ *
* @notapi
*/
uint16_t tp_lld_read_x(void) {
@@ -98,6 +100,8 @@ uint16_t tp_lld_read_x(void) {
/*
* @brief Reads out the Y direction.
*
+ * @return The uncalibrated Y coordinate
+ *
* @notapi
*/
uint16_t tp_lld_read_y(void) {