libcsupport: Doxygen Clean Up Task #1

1 files changed, 51 insertions, 55 deletions

diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h
index 137959a915..9cd0e9651f 100644
--- a/cpukit/libcsupport/include/console.h
+++ b/cpukit/libcsupport/include/console.h
@@ -1,5 +1,7 @@
 /**
- * @file rtems/console.h
+ * @file
+ * 
+ * @brief Console Driver for all Boards
  *
  * This file describes the Console Device Driver for all boards.
  * This driver provides support for the standard C Library.
@@ -24,30 +26,29 @@ extern "C" {
 #endif
 
 /**
- *  This macro defines the standard name for the console device
- *  that is available to applications.
+ * This macro defines the standard name for the console device
+ * that is available to applications.
  */
 #define CONSOLE_DEVICE_NAME "/dev/console"
 
 /**
- *  This macro defines the standard device driver table entry for
- *  a console device driver.
+ * This macro defines the standard device driver table entry for
+ * a console device driver.
  */
 #define CONSOLE_DRIVER_TABLE_ENTRY \
   { console_initialize, console_open, console_close, \
     console_read, console_write, console_control }
 
 /**
- *  @brief Console Initialization Entry Point
+ * @brief Console initialization entry point.
  *
- *  This method initializes the console device driver.
+ * This method initializes the console device driver.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
- *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device driver is successfully initialized.
+ * @param[in] major is the device driver major number.
+ * @param[in] minor is the device driver minor number.
+ * @param[in] arg is the parameters to this call.
+ *.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully initialized.
  */
 rtems_device_driver console_initialize(
   rtems_device_major_number  major,
@@ -56,17 +57,16 @@ rtems_device_driver console_initialize(
 );
 
 /**
- *  @brief Console Open Entry Point
+ * @brief Console open entry point.
  *
- *  This method opens a specific device supported by the
- *  console device driver.
+ * This method opens a specific device supported by the
+ * console device driver.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
  *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device driver is successfully opened.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully opened.
  */
 rtems_device_driver console_open(
   rtems_device_major_number  major,
@@ -75,17 +75,16 @@ rtems_device_driver console_open(
 );
 
 /**
- *  @brief Console Close Entry Point
+ * @brief Console close entry point.
  *
- *  This method closes a specific device supported by the
- *  console device driver.
+ * This method closes a specific device supported by the
+ * console device driver.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
  *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device is successfully closed.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully closed.
  */
 rtems_device_driver console_close(
   rtems_device_major_number  major,
@@ -94,17 +93,16 @@ rtems_device_driver console_close(
 );
 
 /**
- *  @brief Console Read Entry Point
+ * @brief Console read entry point.
  *
- *  This method reads from a specific device supported by the
- *  console device driver.
+ * This method reads from a specific device supported by the
+ * console device driver.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
  *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device is successfully read from.
+ * @retval RTEMS_SUCCESSFUL The device is successfully read from.
  */
 rtems_device_driver console_read(
   rtems_device_major_number  major,
@@ -113,17 +111,16 @@ rtems_device_driver console_read(
 );
 
 /**
- *  @brief Console Write Entry Point
+ * @brief Console write entry point.
  *
- *  This method writes to a specific device supported by the
- *  console device driver.
+ * This method writes to a specific device supported by the
+ * console device driver.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
  *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device is successfully written.
+ * @retval RTEMS_SUCCESSFUL The device is successfully written.
  */
 rtems_device_driver console_write(
   rtems_device_major_number  major,
@@ -132,18 +129,17 @@ rtems_device_driver console_write(
 );
 
 /**
- *  @brief Console IO Control Entry Point
- *
- *  This method performs an IO Control operation on a
- *  specific device supported by the console device driver.
+ * @brief Console IO control entry point.
  *
- *  @param[in] major is the device driver major number
- *  @param[in] minor is the device driver minor number
- *  @param[in] arg is the parameters to this call
+ * This method performs an IO Control operation on a
+ * specific device supported by the console device driver.
  *
- *  @return This method returns RTEMS_SUCCESSFUL when
- *          the device driver IO control operation is
- *          successfully performed.
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
+ * 
+ * @retval RTEMS_SUCCESSFUL the device driver IO control operation is
+ *         successfully performed.
  */
 rtems_device_driver console_control(
   rtems_device_major_number  major,