sapi: Doxygen Clean Up Task #1

1 files changed, 47 insertions, 47 deletions

diff --git a/cpukit/sapi/include/rtems/io.h b/cpukit/sapi/include/rtems/io.h
index 8f02a34e2c..6901d84039 100644
--- a/cpukit/sapi/include/rtems/io.h
+++ b/cpukit/sapi/include/rtems/io.h
@@ -101,13 +101,13 @@ rtems_status_code rtems_io_register_driver(
 );
 
 /**
- *  @brief Unregister a Driver from the Device Driver Table.
+ * @brief Unregister a driver from the device driver table.
  *
- *  @param[in] major is the device major number.
+ * @param[in] major is the device major number.
  *
- *  @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
- *  @retval RTEMS_UNSATISFIED Invalid major number.
- *  @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
+ * @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
+ * @retval RTEMS_UNSATISFIED Invalid major number.
+ * @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
  */
 rtems_status_code rtems_io_unregister_driver(
   rtems_device_major_number major
@@ -131,15 +131,15 @@ rtems_status_code rtems_io_register_name(
 /** @} */
 
 /**
- *  @brief IO Driver Initialization
+ * @brief IO driver initialization.
  *
- *  This routine is the initialization directive of the IO manager.
+ * This routine is the initialization directive of the IO manager.
  *
- *  @param[in] major is the device drive number
- *  @param[in] minor is the device number
- *  @param[in] argument is the pointer to the argument(s)
+ * @param[in] major is the device drive number
+ * @param[in] minor is the device number
+ * @param[in] argument is the pointer to the argument(s)
  *
- *  @return status code
+ * @return status code
  */
 rtems_status_code rtems_io_initialize(
   rtems_device_major_number  major,
@@ -148,15 +148,15 @@ rtems_status_code rtems_io_initialize(
 );
 
 /**
- *  @brief Opening for The IO Manager
+ * @brief Opening for the IO manager.
  *  
- *  Opens a device driver with the number @a major.
+ * Opens a device driver with the number @a major.
  *
- *  @param[in] major is the device driver number.
- *  @param[in] minor is the device number.
- *  @param[in] argument is the pointer to the argument(s).
+ * @param[in] major is the device driver number.
+ * @param[in] minor is the device number.
+ * @param[in] argument is the pointer to the argument(s).
  *
- *  @return Status code.
+ * @return Status code.
  */
 rtems_status_code rtems_io_open(
   rtems_device_major_number  major,
@@ -165,15 +165,15 @@ rtems_status_code rtems_io_open(
 );
 
 /**
- *  @brief Closing for The IO Manager
+ * @brief Closing for the IO manager.
  *  
- *  This routine is the close directive of the IO manager.
+ * This routine is the close directive of the IO manager.
  *
- *  @param[in] major is the device driver number.
- *  @param[in] minor is the device number.
- *  @param[in] argument is the pointer to the argument(s).
+ * @param[in] major is the device driver number.
+ * @param[in] minor is the device number.
+ * @param[in] argument is the pointer to the argument(s).
  *
- *  @return Status code.
+ * @return Status code.
  */
 rtems_status_code rtems_io_close(
   rtems_device_major_number  major,
@@ -182,15 +182,15 @@ rtems_status_code rtems_io_close(
 );
 
 /**
- *  @brief Reading for The IO Manager
+ * @brief Reading for the IO manager.
  *  
- *  This routine is the read directive of the IO manager.
+ * This routine is the read directive of the IO manager.
  *
- *  @param[in] major is the device driver number.
- *  @param[in] minor is the device number.
- *  @param[in] argument is the pointer to the argument(s).
+ * @param[in] major is the device driver number.
+ * @param[in] minor is the device number.
+ * @param[in] argument is the pointer to the argument(s).
  *
- *  @return Status code.
+ * @return Status code.
  */
 rtems_status_code rtems_io_read(
   rtems_device_major_number  major,
@@ -199,15 +199,15 @@ rtems_status_code rtems_io_read(
 );
 
 /**
- *  @brief Writing for The IO Manager
+ * @brief Writing for the IO manager.
  *  
- *  This routine is the write directive of the IO manager.
+ * This routine is the write directive of the IO manager.
  *
- *  @param[in] major is the device driver number.
- *  @param[in] minor is the device number.
- *  @param[in] argument is the pointer to the argument(s).
+ * @param[in] major is the device driver number.
+ * @param[in] minor is the device number.
+ * @param[in] argument is the pointer to the argument(s).
  *
- *  @return Status code.
+ * @return Status code.
  */
 rtems_status_code rtems_io_write(
   rtems_device_major_number  major,
@@ -216,15 +216,15 @@ rtems_status_code rtems_io_write(
 );
 
 /**
- *  @brief Control for The IO Manager
+ * @brief Control for the IO manager.
  *  
- *  This routine is the control directive of the IO manager.
+ * This routine is the control directive of the IO manager.
  *
- *  @param[in] major is the device driver number.
- *  @param[in] minor is the device number.
- *  @param[in] argument is the pointer to the argument(s).
+ * @param[in] major is the device driver number.
+ * @param[in] minor is the device number.
+ * @param[in] argument is the pointer to the argument(s).
  *
- *  @return Status code.
+ * @return Status code.
  */
 rtems_status_code rtems_io_control(
   rtems_device_major_number  major,
@@ -256,18 +256,18 @@ SAPI_IO_EXTERN uint32_t _IO_Number_of_drivers;
 SAPI_IO_EXTERN rtems_driver_address_table *_IO_Driver_address_table;
 
 /**
- *  @brief Initialization of Device Drivers
+ * @brief Initialization of device drivers.
  *
- *  @note The IO manager has been extended to support runtime driver
- *  registration. The driver table is now allocated in the
- *  workspace.
+ * NOTE: The IO manager has been extended to support runtime driver
+ * registration. The driver table is now allocated in the
+ * workspace.
  */
 void _IO_Manager_initialization( void );
 
 /**
- *  @brief Initialization of All Device Drivers
+ * @brief Initialization of all device drivers.
  *
- *  Initializes all device drivers.
+ * Initializes all device drivers.
  */
 void _IO_Initialize_all_drivers( void );