libmisc: Doxygen Clean Up Task #1

Conflicts occured durning this patch and modifications in
the repo were favored over the patch.

2 files changed, 62 insertions, 59 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,
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,