diff options
| author | Joel Bodenmann <joel.bodenmann@hevs.ch> | 2012-11-06 23:55:45 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel.bodenmann@hevs.ch> | 2012-11-06 23:55:45 +0100 |
| commit | b86c313aa2f86836fd8801e1937b1410679d5cb1 (patch) | |
| tree | 8489d75b62c773b8293c24b8bf4934e7d7e7fe91 /drivers | |
| parent | a39a8427d90f9d37ccc98060f08c8dbd6bcc5e94 (diff) | |
| download | uGFX-b86c313aa2f86836fd8801e1937b1410679d5cb1.tar.gz uGFX-b86c313aa2f86836fd8801e1937b1410679d5cb1.tar.bz2 uGFX-b86c313aa2f86836fd8801e1937b1410679d5cb1.zip | |
doxygen tweaks - not complete yet
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/touchpad/ADS7843/touchpad_lld.c | 27 | ||||
| -rw-r--r-- | drivers/touchpad/ADS7843/touchpad_lld_config.h | 3 | ||||
| -rw-r--r-- | drivers/touchpad/XPT2046/touchpad_lld.c | 24 | ||||
| -rw-r--r-- | drivers/touchpad/XPT2046/touchpad_lld_config.h | 3 |
4 files changed, 35 insertions, 22 deletions
diff --git a/drivers/touchpad/ADS7843/touchpad_lld.c b/drivers/touchpad/ADS7843/touchpad_lld.c index 74b06095..ac375e60 100644 --- a/drivers/touchpad/ADS7843/touchpad_lld.c +++ b/drivers/touchpad/ADS7843/touchpad_lld.c @@ -19,10 +19,11 @@ */
/**
- * @file drivers/touchpad/XPT2046/touchpad_lld.c
+ * @file drivers/touchpad/ADS7843/touchpad_lld.c
* @brief Touchpad Driver subsystem low level driver source.
*
- * @addtogroup TOUCHPAD
+ * @defgroup ADS7843
+ * @ingroup DRIVERS
* @{
*/
@@ -85,7 +86,6 @@ void tp_lld_init(const TOUCHPADDriver *tp) { * @param[in] cmd The command bits to send to the touchpad
*
* @return The read value 12-bit right-justified
- *
* @note This function only reads data, it is assumed that the pins are
* configured properly and the bus has been acquired beforehand
*
@@ -107,7 +107,6 @@ uint16_t tp_lld_read_value(uint8_t cmd) { /**
* @brief 7-point median filtering code for touchpad samples
- *
* @note This is an internally used routine only.
*
* @notapi
@@ -129,10 +128,11 @@ static void tp_lld_filter(void) { }
/**
- * @brief Reads out the X direction.
- *
+ * @brief Reads out the X value.
* @note The samples are median filtered for greater noise reduction
*
+ * @return The uncalibrated but filtered X value
+ *
* @notapi
*/
uint16_t tp_lld_read_x(void) {
@@ -170,8 +170,11 @@ uint16_t tp_lld_read_x(void) { return sampleBuf[3];
}
-/*
- * @brief Reads out the Y direction.
+/**
+ * @brief Reads out the Y value.
+ * @note The samples are median filtered for greater noise reduction
+ *
+ * @return The uncalibrated but filtered Y value
*
* @notapi
*/
@@ -212,8 +215,8 @@ uint16_t tp_lld_read_y(void) { /* ---- Optional Routines ---- */
#if TOUCHPAD_HAS_IRQ || defined(__DOXYGEN__)
- /*
- * @brief for checking if touchpad is pressed or not.
+ /**
+ * @brief For checking if touchpad is pressed or not.
*
* @return 1 if pressed / 0 if not pressed
*
@@ -225,9 +228,11 @@ uint16_t tp_lld_read_y(void) { #endif
#if TOUCHPAD_HAS_PRESSURE || defined(__DOXYGEN__)
- /*
+ /**
* @brief Reads out the Z direction / pressure.
*
+ * @return The amount of preasure
+ *
* @notapi
*/
uint16_t tp_lld_read_z(void) {
diff --git a/drivers/touchpad/ADS7843/touchpad_lld_config.h b/drivers/touchpad/ADS7843/touchpad_lld_config.h index 13b48922..dd2c9dda 100644 --- a/drivers/touchpad/ADS7843/touchpad_lld_config.h +++ b/drivers/touchpad/ADS7843/touchpad_lld_config.h @@ -22,7 +22,8 @@ * @file drivers/touchpad/ADS7843/touchpad_lld_config.h
* @brief Touchpad Driver subsystem low level driver.
*
- * @addtogroup TOUCHPAD
+ * @defgroup ADS7843
+ * @ingroup DRIVERS
* @{
*/
diff --git a/drivers/touchpad/XPT2046/touchpad_lld.c b/drivers/touchpad/XPT2046/touchpad_lld.c index 50ff6acc..42f3e8d2 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld.c +++ b/drivers/touchpad/XPT2046/touchpad_lld.c @@ -22,7 +22,8 @@ * @file drivers/touchpad/XPT2046/touchpad_lld.c
* @brief Touchpad Driver subsystem low level driver source.
*
- * @addtogroup TOUCHPAD
+ * @defgroup XPT2046
+ * @ingroup DRIVERS
* @{
*/
@@ -107,8 +108,7 @@ uint16_t tp_lld_read_value(uint8_t cmd) { /**
* @brief 7-point median filtering code for touchpad samples
- *
- * @note This is an internally used routine only.
+ * @note This is an internally used routine only
*
* @notapi
*/
@@ -129,10 +129,11 @@ static void tp_lld_filter(void) { }
/**
- * @brief Reads out the X direction.
- *
+ * @brief Reads out the X value.
* @note The samples are median filtered for greater noise reduction
*
+ * @return The uncalibrated but filtered X value
+ *
* @notapi
*/
uint16_t tp_lld_read_x(void) {
@@ -170,8 +171,11 @@ uint16_t tp_lld_read_x(void) { return sampleBuf[3];
}
-/*
- * @brief Reads out the Y direction.
+/**
+ * @brief Reads out the Y value.
+ * @note The samples are median filtered for greated noise reduction
+ *
+ * @return The uncalibrated but filtered Y value
*
* @notapi
*/
@@ -212,7 +216,7 @@ uint16_t tp_lld_read_y(void) { /* ---- Optional Routines ---- */
#if TOUCHPAD_HAS_IRQ || defined(__DOXYGEN__)
- /*
+ /**
* @brief for checking if touchpad is pressed or not.
*
* @return 1 if pressed / 0 if not pressed
@@ -225,9 +229,11 @@ uint16_t tp_lld_read_y(void) { #endif
#if TOUCHPAD_HAS_PRESSURE || defined(__DOXYGEN__)
- /*
+ /**
* @brief Reads out the Z direction / pressure.
*
+ * @return The mount of preasure
+ *
* @notapi
*/
uint16_t tp_lld_read_z(void) {
diff --git a/drivers/touchpad/XPT2046/touchpad_lld_config.h b/drivers/touchpad/XPT2046/touchpad_lld_config.h index f1cd9ff5..d0d1fb61 100644 --- a/drivers/touchpad/XPT2046/touchpad_lld_config.h +++ b/drivers/touchpad/XPT2046/touchpad_lld_config.h @@ -22,7 +22,8 @@ * @file drivers/touchpad/XPT2046/touchpad_lld_config.h
* @brief Touchppad Driver subsystem low level driver.
*
- * @addtogroup TOUCHPAD
+ * @defgroup XPT2046
+ * @ingroup DRIVERS
* @{
*/
|