summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/mouse/mouse_parser.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libmisc/mouse/mouse_parser.h')
-rw-r--r--cpukit/libmisc/mouse/mouse_parser.h40
1 files changed, 22 insertions, 18 deletions
diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h
index 8b42c4464f..27bea1bbbc 100644
--- a/cpukit/libmisc/mouse/mouse_parser.h
+++ b/cpukit/libmisc/mouse/mouse_parser.h
@@ -1,6 +1,8 @@
/**
* @file rtems/mouse_parser.h
*
+ * @brief Initialize Mouse Parser Engine
+ *
* This file is the header file for the Mouse Parser Engine.
*/
@@ -37,33 +39,33 @@
#include <rtems/mw_uid.h>
/**
- * @defgroup libmisc_mouse Mouse Parser Engine
- *
- * @ingroup libmisc
+ * @defgroup libmisc_mouseparser Mouse Parser Engine
+ * @ingroup libmisc_mouse
*/
/**@{*/
+
#ifdef __cplusplus
extern "C" {
#endif
/**
- * This is the mask for the right button.
+ * This is the mask for the right button.
*
- * @note Use the same definitions as the user interface.
+ * @note Use the same definitions as the user interface.
*/
#define RBUTTON MV_BUTTON_RIGHT
/**
* This is the mask for the center button.
*
- * @note Use the same definitions as the user interface.
+ * @note Use the same definitions as the user interface.
*/
#define MBUTTON MV_BUTTON_CENTER
/**
- * This is the mask for the left button.
+ * This is the mask for the left button.
*
- * @note Use the same definitions as the user interface.
+ * @note Use the same definitions as the user interface.
*/
#define LBUTTON MV_BUTTON_LEFT
@@ -85,25 +87,25 @@ typedef unsigned int BUTTON;
typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t);
/**
- * @brief Initialize the mouse parser engine.
+ * @brief Initialize the mouse parser engine.
*
- * This method initializes the Mouse Parser Engine for the mouse
- * of @a type. The @a type should be one of the following strings:
- * pc ms, logi, ps2.
+ * This method initializes the Mouse Parser Engine for the mouse
+ * of @a type. The @a type should be one of the following strings:
+ * pc ms, logi, ps2.
*
- * @a param[in] type indicates the type of mouse.
+ * @a param[in] type indicates the type of mouse.
*
- * @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
*/
int mouse_parser_initialize(const char *type);
/**
- * @brief Enqueue input to the mouse parser engine.
+ * @brief Enqueue input to the mouse parser engine.
*
- * This method is used to pass mouse input to the Mouse Parser Engine.
+ * This method is used to pass mouse input to the Mouse Parser Engine.
*
- * @a param[in] buffer is the data to enqueue
- * @a param[in] size is the amount of data to enqueue
+ * @a param[in] buffer is the data to enqueue
+ * @a param[in] size is the amount of data to enqueue
*/
void mouse_parser_enqueue(
unsigned char *buffer,
@@ -114,4 +116,6 @@ void mouse_parser_enqueue(
}
#endif
+/**@}*/
+
#endif