summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/mouse/serial_mouse.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/serial_mouse.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/serial_mouse.h')
-rw-r--r--cpukit/libmisc/mouse/serial_mouse.h86
1 files changed, 43 insertions, 43 deletions
diff --git a/cpukit/libmisc/mouse/serial_mouse.h b/cpukit/libmisc/mouse/serial_mouse.h
index 44d46338d7..e4f0ee4491 100644
--- a/cpukit/libmisc/mouse/serial_mouse.h
+++ b/cpukit/libmisc/mouse/serial_mouse.h
@@ -43,13 +43,13 @@ extern "C" {
serial_mouse_read, serial_mouse_write, serial_mouse_control }
/**
- * @brief The initialization of the serial mouse driver.
+ * @brief The initialization of the serial mouse driver.
*
- * This method initializes the serial mouse driver.
+ * This method initializes the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_initialize(
rtems_device_major_number major,
@@ -58,14 +58,14 @@ rtems_device_driver serial_mouse_initialize(
);
/**
- * @brief Open device driver entry point for the serial mouse driver.
+ * @brief Open device driver entry point for the serial mouse driver.
*
- * This method implements the Open device driver entry
- * point for the serial mouse driver.
+ * This method implements the Open device driver entry
+ * point for the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_open(
rtems_device_major_number major,
@@ -74,14 +74,14 @@ rtems_device_driver serial_mouse_open(
);
/**
- * @brief Close device driver entry point for the serial mouse driver.
+ * @brief Close device driver entry point for the serial mouse driver.
*
- * This method implements the Close device driver entry
- * point for the serial mouse driver.
+ * This method implements the Close device driver entry
+ * point for the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_close(
rtems_device_major_number major,
@@ -90,14 +90,14 @@ rtems_device_driver serial_mouse_close(
);
/**
- * @brief Read device driver entry point for the serial mouse driver.
+ * @brief Read device driver entry point for the serial mouse driver.
*
- * This method implements the Read device driver entry
- * point for the serial mouse driver.
+ * This method implements the Read device driver entry
+ * point for the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_read(
rtems_device_major_number major,
@@ -106,14 +106,14 @@ rtems_device_driver serial_mouse_read(
);
/**
- * @brief Write device driver entry point for the serial mouse driver.
+ * @brief Write device driver entry point for the serial mouse driver.
*
- * This method implements the Write device driver entry
- * point for the serial mouse driver.
+ * This method implements the Write device driver entry
+ * point for the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_write(
rtems_device_major_number major,
@@ -122,14 +122,14 @@ rtems_device_driver serial_mouse_write(
);
/**
- * @brief IO Control device driver entry point for the serial mouse driver.
+ * @brief IO Control device driver entry point for the serial mouse driver.
*
- * This method implements the IO Control device driver entry
- * point for the serial mouse driver.
+ * This method implements the IO Control device driver entry
+ * point for the serial mouse driver.
*
- * @param[in] major is the mouse device major number
- * @param[in] minor is the mouse device minor number
- * @param[in] arguments points to device driver arguments
+ * @param[in] major is the mouse device major number
+ * @param[in] minor is the mouse device minor number
+ * @param[in] arguments points to device driver arguments
*/
rtems_device_driver serial_mouse_control(
rtems_device_major_number major,
@@ -138,17 +138,17 @@ rtems_device_driver serial_mouse_control(
);
/**
- * @brief Obtain serial mouse configuration information.
+ * @brief Obtain serial mouse configuration information.
*
- * This method is implemented by the BSP or application and
- * tells the driver what device to open() and what type of
- * mouse is connected.
+ * This method is implemented by the BSP or application and
+ * tells the driver what device to open() and what type of
+ * mouse is connected.
*
- * @param[in] name will point to a string with the device name
- * of the serial port with the mouse connected.
- * @param[in] type will point to a string with the type of mouse connected.
+ * @param[in] name will point to a string with the device name
+ * of the serial port with the mouse connected.
+ * @param[in] type will point to a string with the type of mouse connected.
*
- * @return This method returns true on success and false on error.
+ * @retval This method returns true on success and false on error.
*/
bool bsp_get_serial_mouse_device(
const char **name,