libmisc: Doxygen Enhancement Task #1

4 files changed, 41 insertions, 14 deletions

diff --git a/cpukit/libmisc/mouse/mouse_parser.c b/cpukit/libmisc/mouse/mouse_parser.c
index 2f96e1567f..6ca871bf52 100644
--- a/cpukit/libmisc/mouse/mouse_parser.c
+++ b/cpukit/libmisc/mouse/mouse_parser.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Opens a Serial Port Directly, and Interprets Serial Data
+ * @ingroup libmisc_mouse Mouse Parser Engine
+ */
+
 /*
  * This code is derived from a UNIX Serial Port Mouse Driver with
  * the following notice:
@@ -19,7 +26,7 @@
  * ==================================================================
  *
  * It has been modified to support the concept of being just a parser
- * fed data from an arbitrary source.  It is independent of either 
+ * fed data from an arbitrary source.  It is independent of either
  * a PS/2 driver or a serial port.
  *
  * It was moved to cpukit/libmisc/mouse by Joel Sherrill.
@@ -135,7 +142,7 @@ static int MOU_Data( int ch, COORD *dx, COORD *dy, COORD *dz, BUTTON *bptr)
   if ( !parse ) {
     printk( "Mouse parser is not initialized!\n" );
     return -1;
-  } 
+  }
 
   /*
    * Loop over all the bytes read in the buffer, parsing them.
diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h
index 51bcb2deef..8b42c4464f 100644
--- a/cpukit/libmisc/mouse/mouse_parser.h
+++ b/cpukit/libmisc/mouse/mouse_parser.h
@@ -25,7 +25,7 @@
  * ==================================================================
  *
  * It has been modified to support the concept of being just a parser
- * fed data from an arbitrary source.  It is independent of either 
+ * fed data from an arbitrary source.  It is independent of either
  * a PS/2 driver or a serial port.
  *
  * It was moved to cpukit/libmisc/mouse by Joel Sherrill.
@@ -36,6 +36,12 @@
 
 #include <rtems/mw_uid.h>
 
+/**
+ *  @defgroup libmisc_mouse Mouse Parser Engine
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -79,7 +85,7 @@ 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:
@@ -92,7 +98,7 @@ typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t);
 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.
  *
diff --git a/cpukit/libmisc/mouse/serial_mouse.c b/cpukit/libmisc/mouse/serial_mouse.c
index 4175fa07fe..cdeaa29faf 100644
--- a/cpukit/libmisc/mouse/serial_mouse.c
+++ b/cpukit/libmisc/mouse/serial_mouse.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Serial Mouse Driver
+ * @ingroup libmisc_mouse Serial Mouse Driver
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
@@ -26,7 +33,7 @@ const char *serial_mouse_type;
 static int serial_mouse_l_rint(int c, struct rtems_termios_tty *tp)
 {
   unsigned char buf = c;
-  
+
   /* call mouse_parser( void *ptr, char *buffer, int size ) */
   mouse_parser_enqueue( &buf, 1 );
   return 0;
diff --git a/cpukit/libmisc/mouse/serial_mouse.h b/cpukit/libmisc/mouse/serial_mouse.h
index 8cb966ec7b..314e49bbd0 100644
--- a/cpukit/libmisc/mouse/serial_mouse.h
+++ b/cpukit/libmisc/mouse/serial_mouse.h
@@ -23,6 +23,13 @@
 #define __SERIAL_MOUSE_h__
 
 /* functions */
+
+/**
+ *  @defgroup libmisc_mouse Serial Mouse Driver
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -35,7 +42,7 @@ extern "C" {
     serial_mouse_read, serial_mouse_write, serial_mouse_control }
 
 /**
- *  @brief Serial Mouse Driver Initialization
+ *  @brief The initialization of the serial mouse driver.
  *
  *  This method initializes the serial mouse driver.
  *
@@ -50,7 +57,7 @@ rtems_device_driver serial_mouse_initialize(
 );
 
 /**
- *  @brief Serial Mouse Driver Open
+ *  @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.
@@ -66,7 +73,7 @@ rtems_device_driver serial_mouse_open(
 );
 
 /**
- *  @brief Serial Mouse Driver Close
+ *  @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.
@@ -82,7 +89,7 @@ rtems_device_driver serial_mouse_close(
 );
 
 /**
- *  @brief Serial Mouse Driver Read
+ *  @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.
@@ -98,7 +105,7 @@ rtems_device_driver serial_mouse_read(
 );
 
 /**
- *  @brief Serial Mouse Driver Write
+ *  @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.
@@ -114,7 +121,7 @@ rtems_device_driver serial_mouse_write(
 );
 
 /**
- *  @brief Serial Mouse Driver IO Control
+ *  @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.
@@ -130,7 +137,7 @@ 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
@@ -150,5 +157,5 @@ bool bsp_get_serial_mouse_device(
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif  /* __tty_drv__  */