summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/mouse/mouse_parser.h
diff options
context:
space:
mode:
authorAyush Awasthi <kolaveridi87@gmail.com>2013-01-04 13:09:14 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2013-01-04 13:09:14 -0600
commita163882dae2f2935e19ec96f0d2a85d1c652be35 (patch)
tree8b2ea781569d24496f99d805bd0a04a88b7a29fc /cpukit/libmisc/mouse/mouse_parser.h
parentposix: Doxygen Clean Up Task #2 (diff)
downloadrtems-a163882dae2f2935e19ec96f0d2a85d1c652be35.tar.bz2
libmisc: Doxygen Clean Up Task #1
Conflicts occured durning this patch and modifications in the repo were favored over the patch.
Diffstat (limited to 'cpukit/libmisc/mouse/mouse_parser.h')
-rw-r--r--cpukit/libmisc/mouse/mouse_parser.h35
1 files changed, 19 insertions, 16 deletions
diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h
index cdd50826cf..3d2dad1695 100644
--- a/cpukit/libmisc/mouse/mouse_parser.h
+++ b/cpukit/libmisc/mouse/mouse_parser.h
@@ -1,7 +1,10 @@
/**
* @file rtems/mouse_parser.h
*
- * @brief Mouse Parser Engine
+ * @defgroup libmisc_mouse Mouse Parser Engine
+ *
+ * @ingroup libmisc
+ * @brief Initialize Mouse Parser Engine
*
* This file is the header file for the Mouse Parser Engine.
*/
@@ -51,23 +54,23 @@ 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
@@ -89,25 +92,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,