summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-12-07 09:49:54 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-07 09:49:54 -0500
commit4c98a3ea294f3eb0cbaae4153c47eb45728613ac (patch)
tree897abe1cfe7b6a78859f77810c16a8a24fcd0456
parentbsps/powerpc: Use explicit compiler options (diff)
downloadrtems-4c98a3ea294f3eb0cbaae4153c47eb45728613ac.tar.bz2
sapi misc: Clean up Doxygen GCI task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8011204
-rw-r--r--cpukit/rtems/include/rtems/rtems/rtemsapi.h2
-rw-r--r--cpukit/sapi/include/rtems/extension.h5
-rw-r--r--cpukit/sapi/include/rtems/fatal.h12
-rw-r--r--cpukit/sapi/include/rtems/init.h2
-rw-r--r--cpukit/sapi/include/rtems/io.h112
-rw-r--r--cpukit/sapi/src/debug.c21
-rw-r--r--cpukit/sapi/src/exinit.c8
-rw-r--r--cpukit/sapi/src/exshutdown.c2
-rw-r--r--cpukit/sapi/src/extension.c18
-rw-r--r--cpukit/sapi/src/extensiondata.c10
-rw-r--r--cpukit/sapi/src/fatal.c20
-rw-r--r--cpukit/sapi/src/fatal2.c8
-rw-r--r--cpukit/sapi/src/getversionstring.c8
-rw-r--r--cpukit/sapi/src/interrdesc.c8
-rw-r--r--cpukit/sapi/src/io.c29
-rw-r--r--cpukit/sapi/src/ioclose.c22
-rw-r--r--cpukit/sapi/src/iocontrol.c24
-rw-r--r--cpukit/sapi/src/iodata.c10
-rw-r--r--cpukit/sapi/src/ioinitialize.c24
-rw-r--r--cpukit/sapi/src/ioopen.c22
-rw-r--r--cpukit/sapi/src/ioread.c24
-rw-r--r--cpukit/sapi/src/iounregisterdriver.c23
-rw-r--r--cpukit/sapi/src/iowrite.c24
-rw-r--r--cpukit/sapi/src/posixapi.c22
-rw-r--r--cpukit/sapi/src/rtemsapi.c23
-rw-r--r--cpukit/score/include/rtems/debug.h8
26 files changed, 271 insertions, 220 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/rtemsapi.h b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
index d39acd35c0..5d74fa6790 100644
--- a/cpukit/rtems/include/rtems/rtems/rtemsapi.h
+++ b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
@@ -18,7 +18,7 @@
#include <rtems/config.h>
/**
- * _RTEMS_API_Initialize
+ * @brief Initializes the RTEMS API
*
* This routine initializes the RTEMS API by invoking the initialization
* routine for each RTEMS manager with the appropriate parameters
diff --git a/cpukit/sapi/include/rtems/extension.h b/cpukit/sapi/include/rtems/extension.h
index f9f1ae1381..3d54092a8c 100644
--- a/cpukit/sapi/include/rtems/extension.h
+++ b/cpukit/sapi/include/rtems/extension.h
@@ -38,6 +38,11 @@ typedef struct {
User_extensions_Control Extension;
} Extension_Control;
+/**
+ * @brief Initialize Extension Manager
+ *
+ * This routine initializes all extension manager related data structures.
+ */
void _Extension_Manager_initialization(void);
typedef User_extensions_routine
diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h
index 64344b36b8..7b7c5b1925 100644
--- a/cpukit/sapi/include/rtems/fatal.h
+++ b/cpukit/sapi/include/rtems/fatal.h
@@ -57,9 +57,7 @@ static inline void rtems_exception_frame_print(
* @brief Invokes the internal error handler with a source of
* INTERNAL_ERROR_RTEMS_API and is internal set to false.
*
- * @param[in] the_error A 32-bit fatal error code.
- *
- * @return This function will not return.
+ * @param[in] the_error is a 32-bit fatal error code.
*
* @see _Internal_error_Occurred().
*/
@@ -70,10 +68,8 @@ void rtems_fatal_error_occurred(
/**
* @brief Invokes the internal error handler with is internal set to false.
*
- * @param[in] source The fatal source.
- * @param[in] error The fatal code.
- *
- * @return This function will not return.
+ * @param[in] source is the fatal source.
+ * @param[in] error is the fatal code.
*
* @see _Internal_error_Occurred().
*/
@@ -85,7 +81,7 @@ void rtems_fatal(
/**
* @brief Returns a description for an internal error code.
*
- * @param[in] error The error code.
+ * @param[in] error is the error code.
*
* @return The error code description or "?" in case the passed error code is
* invalid.
diff --git a/cpukit/sapi/include/rtems/init.h b/cpukit/sapi/include/rtems/init.h
index 95b7cc79e6..8b5fab91fd 100644
--- a/cpukit/sapi/include/rtems/init.h
+++ b/cpukit/sapi/include/rtems/init.h
@@ -87,7 +87,7 @@ void rtems_initialize_start_multitasking(void)
RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
/**
- * @brief rtems_shutdown_executive
+ * @brief Shutdown the RTEMS environment
*
* This routine implements the rtems_shutdown_executive directive. The
* invocation of this directive results in the RTEMS environment being
diff --git a/cpukit/sapi/include/rtems/io.h b/cpukit/sapi/include/rtems/io.h
index 5477860b5a..627b53581c 100644
--- a/cpukit/sapi/include/rtems/io.h
+++ b/cpukit/sapi/include/rtems/io.h
@@ -100,11 +100,13 @@ rtems_status_code rtems_io_register_driver(
);
/**
- * @brief Unregisters the device driver with number @a major.
+ * @brief Unregister a Driver from the Device Driver Table.
*
- * @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
- * @retval RTEMS_UNSATISFIED Invalid major number.
- * @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
+ * @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.
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
@@ -126,41 +128,101 @@ rtems_status_code rtems_io_register_name(
/** @} */
/**
- * @name Device Driver Invocation
+ * @brief IO Driver Initialization
*
- * @{
+ * 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)
+ *
+ * @return status code
*/
-
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
+/**
+ * @brief Opening for The IO Manager
+ *
+ * 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).
+ *
+ * @return Status code.
+ */
rtems_status_code rtems_io_open(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
+/**
+ * @brief Closing for 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).
+ *
+ * @return Status code.
+ */
rtems_status_code rtems_io_close(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
+/**
+ * @brief Reading for 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).
+ *
+ * @return Status code.
+ */
rtems_status_code rtems_io_read(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
+/**
+ * @brief Writing for 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).
+ *
+ * @return Status code.
+ */
rtems_status_code rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
+/**
+ * @brief Control for 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).
+ *
+ * @return Status code.
+ */
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
@@ -190,8 +252,20 @@ 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
+ *
+ * @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
+ *
+ * Initializes all device drivers.
+ */
void _IO_Initialize_all_drivers( void );
#ifdef __cplusplus
@@ -199,4 +273,26 @@ void _IO_Initialize_all_drivers( void );
#endif
#endif
-/* end of include file */
+ rtems_io_write(
+ rtems_device_major_number major,
+ rtems_device_minor_number minor,
+ void *argument
+);
+
+/**
+ * @brief Control for 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).
+ *
+ * @return Status code.
+ */
+rtems_status_code rtems_io_control(
+ rtems_device_major_number major,
+ rtems_device_minor_number minor,
+ void *argument
+);
+
diff --git a/cpukit/sapi/src/debug.c b/cpukit/sapi/src/debug.c
index f24bd3a757..f886f3aed8 100644
--- a/cpukit/sapi/src/debug.c
+++ b/cpukit/sapi/src/debug.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Debug Manager
+ *
+ * @ingroup ClassicDebug
+ */
+
/*
* Debug Manager
*
@@ -16,18 +24,11 @@
#include <rtems/system.h>
#include <rtems/debug.h>
-/*
- *
- * _Debug_Manager_initialization
- */
void _Debug_Manager_initialization( void )
{
rtems_debug_disable( RTEMS_DEBUG_ALL_MASK );
}
-/*
- * rtems_debug_enable
- */
void rtems_debug_enable (
rtems_debug_control to_be_enabled
)
@@ -35,9 +36,6 @@ void rtems_debug_enable (
_Debug_Level |= to_be_enabled;
}
-/*
- * rtems_debug_disable
- */
void rtems_debug_disable (
rtems_debug_control to_be_disabled
)
@@ -45,9 +43,6 @@ void rtems_debug_disable (
_Debug_Level &= ~to_be_disabled;
}
-/*
- * rtems_debug_is_enabled
- */
bool rtems_debug_is_enabled(
rtems_debug_control level
)
diff --git a/cpukit/sapi/src/exinit.c b/cpukit/sapi/src/exinit.c
index a48ad9b56e..34e80750dd 100644
--- a/cpukit/sapi/src/exinit.c
+++ b/cpukit/sapi/src/exinit.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Device Driver Initialization Functions
+ *
+ * @ingroup ClassicRTEMS
+ */
+
/*
* Initialization Manager
*
diff --git a/cpukit/sapi/src/exshutdown.c b/cpukit/sapi/src/exshutdown.c
index 6e3e1c9897..2b99995825 100644
--- a/cpukit/sapi/src/exshutdown.c
+++ b/cpukit/sapi/src/exshutdown.c
@@ -51,11 +51,9 @@ void rtems_shutdown_executive(
/*******************************************************************
*******************************************************************
- *******************************************************************
****** RETURN TO RTEMS_INITIALIZE_START_MULTITASKING() ******
****** AND THEN TO BOOT_CARD() ******
*******************************************************************
- *******************************************************************
*******************************************************************/
}
_Internal_error_Occurred(
diff --git a/cpukit/sapi/src/extension.c b/cpukit/sapi/src/extension.c
index 9038b2981f..29ceebcec5 100644
--- a/cpukit/sapi/src/extension.c
+++ b/cpukit/sapi/src/extension.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Initialize Extension Manager
+ *
+ * @ingroup ClassicUserExtensions
+ */
+
/*
* Extension Manager
*
@@ -20,16 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/extension.h>
-/*
- * _Extension_Manager_initialization
- *
- * This routine initializes all extension manager related data structures.
- *
- * Input parameters: NONE
- *
- * Output parameters: NONE
- */
-
void _Extension_Manager_initialization(void)
{
_Objects_Initialize_information(
diff --git a/cpukit/sapi/src/extensiondata.c b/cpukit/sapi/src/extensiondata.c
index 1a8c134597..b604274a87 100644
--- a/cpukit/sapi/src/extensiondata.c
+++ b/cpukit/sapi/src/extensiondata.c
@@ -1,6 +1,12 @@
-/*
- * Extension Manager -- Instantiate Data
+/**
+ * @file
+ *
+ * @brief Extension Data
*
+ * @ingroup ClassicUserExtensions
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/src/fatal.c b/cpukit/sapi/src/fatal.c
index 08c8a1e2c0..9dc27fabfd 100644
--- a/cpukit/sapi/src/fatal.c
+++ b/cpukit/sapi/src/fatal.c
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @brief Invokes the internal error handler with a source of
+ * INTERNAL_ERROR_RTEMS_API and is internal set to false.
+ *
+ * @ingroup ClassicFatal
+ */
+
/*
* Fatal Error Manager
*
@@ -17,17 +26,6 @@
#include <rtems/fatal.h>
#include <rtems/score/interr.h>
-/*
- * rtems_fatal_error_occurred
- *
- * This directive will invoke the internal fatal error handler.
- *
- * Input parameters:
- * the_error - fatal error status code
- *
- * Output parameters: NONE
- */
-
void rtems_fatal_error_occurred(
uint32_t the_error
)
diff --git a/cpukit/sapi/src/fatal2.c b/cpukit/sapi/src/fatal2.c
index efaf4265ed..0c895b8132 100644
--- a/cpukit/sapi/src/fatal2.c
+++ b/cpukit/sapi/src/fatal2.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Invokes the internal error handler with is internal set to false.
+ *
+ * @ingroup ClassicFatal
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/sapi/src/getversionstring.c b/cpukit/sapi/src/getversionstring.c
index 2518e0f6ce..463fe81652 100644
--- a/cpukit/sapi/src/getversionstring.c
+++ b/cpukit/sapi/src/getversionstring.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Get the RTEMS Version as a String
+ *
+ * @ingroup ClassicRTEMS
+ */
+
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/sapi/src/interrdesc.c b/cpukit/sapi/src/interrdesc.c
index 5eab68313b..5301475657 100644
--- a/cpukit/sapi/src/interrdesc.c
+++ b/cpukit/sapi/src/interrdesc.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Returns a description for an internal error code.
+ *
+ * @ingroup ClassicFatal
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/sapi/src/io.c b/cpukit/sapi/src/io.c
index 47793c3036..e01417bfe4 100644
--- a/cpukit/sapi/src/io.c
+++ b/cpukit/sapi/src/io.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Initialize Device Driver Subsystem
+/**
+ * @file
+ *
+ * @brief Initialization of Device Drivers
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -22,15 +28,6 @@
#include <string.h>
-/*
- * _IO_Manager_initialization
- *
- * 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)
{
uint32_t index;
@@ -80,16 +77,6 @@ void _IO_Manager_initialization(void)
_IO_Driver_address_table[index] = driver_table[index];
}
-/*
- * _IO_Initialize_all_drivers
- *
- * This routine initializes all device drivers
- *
- * Input Paramters: NONE
- *
- * Output Parameters: NONE
- */
-
void _IO_Initialize_all_drivers( void )
{
rtems_device_major_number major;
diff --git a/cpukit/sapi/src/ioclose.c b/cpukit/sapi/src/ioclose.c
index 3f459f8a4d..d58e9b8a71 100644
--- a/cpukit/sapi/src/ioclose.c
+++ b/cpukit/sapi/src/ioclose.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Closing for The IO Manager
+ *
+ * @ingroup ClassicIO
+ */
+
/*
* Input/Output Manager -- Close Device
*
@@ -16,20 +24,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_close
- *
- * This routine is the close directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_close(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/iocontrol.c b/cpukit/sapi/src/iocontrol.c
index d1002cb773..fa6ad761d9 100644
--- a/cpukit/sapi/src/iocontrol.c
+++ b/cpukit/sapi/src/iocontrol.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Device Control
+/**
+ * @file
+ *
+ * @brief Control for The IO Manager
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_control
- *
- * This routine is the control directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/iodata.c b/cpukit/sapi/src/iodata.c
index 082a28f03c..8809b559d6 100644
--- a/cpukit/sapi/src/iodata.c
+++ b/cpukit/sapi/src/iodata.c
@@ -1,6 +1,12 @@
-/*
- * RTEMS Task Manager -- Instantiate Data
+/**
+ * @file
+ *
+ * @brief IO Data
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/src/ioinitialize.c b/cpukit/sapi/src/ioinitialize.c
index 273792dd83..62f694bea6 100644
--- a/cpukit/sapi/src/ioinitialize.c
+++ b/cpukit/sapi/src/ioinitialize.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Initialize Device
+/**
+ * @file
+ *
+ * @brief IO Driver Initialization
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_initialize
- *
- * This routine is the initialization directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/ioopen.c b/cpukit/sapi/src/ioopen.c
index 2d9dc67b38..6d4bf8f768 100644
--- a/cpukit/sapi/src/ioopen.c
+++ b/cpukit/sapi/src/ioopen.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Opening for The IO Manager
+ *
+ * @ingroup ClassicIO
+ */
+
/*
* Input/Output Manager - Open Device
*
@@ -16,20 +24,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_open
- *
- * This routine is the open directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_open(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/ioread.c b/cpukit/sapi/src/ioread.c
index c219b98911..591be7f252 100644
--- a/cpukit/sapi/src/ioread.c
+++ b/cpukit/sapi/src/ioread.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Device Read
+/**
+ * @file
+ *
+ * @brief Reading for The IO Manager
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_read
- *
- * This routine is the read directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_read(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/iounregisterdriver.c b/cpukit/sapi/src/iounregisterdriver.c
index 433e94b1a9..7836641d24 100644
--- a/cpukit/sapi/src/iounregisterdriver.c
+++ b/cpukit/sapi/src/iounregisterdriver.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Dynamically Unregister Device Driver
+/**
+ * @file
+ *
+ * @brief Unregister a Driver from the Device Driver Table.
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,19 +25,6 @@
#include <rtems/score/thread.h>
#include <string.h>
-/*
- * rtems_io_unregister_driver
- *
- * Unregister a driver from the device driver table.
- *
- * Input Paramters:
- * major - device major number
- *
- * Output Parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
)
diff --git a/cpukit/sapi/src/iowrite.c b/cpukit/sapi/src/iowrite.c
index 287461701d..285de30f4a 100644
--- a/cpukit/sapi/src/iowrite.c
+++ b/cpukit/sapi/src/iowrite.c
@@ -1,6 +1,12 @@
-/*
- * Input/Output Manager - Device Write
+/**
+ * @file
+ *
+ * @brief Writing for The IO Manager
*
+ * @ingroup ClassicIO
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,20 +22,6 @@
#include <rtems/system.h>
#include <rtems/io.h>
-/*
- * rtems_io_write
- *
- * This routine is the write directive of the IO manager.
- *
- * Input Paramters:
- * major - device driver number
- * minor - device number
- * argument - pointer to argument(s)
- *
- * Output Parameters:
- * returns - return code
- */
-
rtems_status_code rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
diff --git a/cpukit/sapi/src/posixapi.c b/cpukit/sapi/src/posixapi.c
index a6ea4cb489..3f65442021 100644
--- a/cpukit/sapi/src/posixapi.c
+++ b/cpukit/sapi/src/posixapi.c
@@ -1,8 +1,12 @@
-/*
- * RTEMS API Initialization Support
+/**
+ * @file
*
- * NOTE:
+ * @brief Initialize POSIX API
*
+ * @ingroup ClassicRTEMS
+ */
+
+/*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
*
@@ -15,11 +19,6 @@
#include "config.h"
#endif
-/*
- * POSIX_API_INIT is defined so all of the POSIX API
- * data will be included in this object file.
- */
-
#define POSIX_API_INIT
#include <rtems/system.h> /* include this before checking RTEMS_POSIX_API */
@@ -45,12 +44,6 @@
#include <rtems/posix/spinlock.h>
#include <rtems/posix/time.h>
-/*
- * _POSIX_API_Initialize
- *
- * XXX
- */
-
Objects_Information *_POSIX_Objects[ OBJECTS_POSIX_CLASSES_LAST + 1 ];
void _POSIX_API_Initialize(void)
@@ -82,4 +75,3 @@ void _POSIX_API_Initialize(void)
}
#endif
-/* end of file */
diff --git a/cpukit/sapi/src/rtemsapi.c b/cpukit/sapi/src/rtemsapi.c
index d90a36edde..d59daa19c5 100644
--- a/cpukit/sapi/src/rtemsapi.c
+++ b/cpukit/sapi/src/rtemsapi.c
@@ -1,8 +1,12 @@
-/*
- * POSIX API Initialization Support
+/**
+ * @file
*
- * NOTE:
+ * @brief Initializes the RTEMS API
*
+ * @ingroup ClassicRTEMS
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -15,11 +19,6 @@
#include "config.h"
#endif
-/*
- * RTEMS_API_INIT is defined so all of the RTEMS API
- * data will be included in this object file.
- */
-
#define RTEMS_API_INIT
#include <rtems/system.h>
@@ -45,12 +44,6 @@
Objects_Information *_RTEMS_Objects[ OBJECTS_RTEMS_CLASSES_LAST + 1 ];
-/*
- * _RTEMS_API_Initialize
- *
- * XXX
- */
-
void _RTEMS_API_Initialize(void)
{
/*
@@ -75,5 +68,3 @@ void _RTEMS_API_Initialize(void)
_Rate_monotonic_Manager_initialization();
_Barrier_Manager_initialization();
}
-
-/* end of file */
diff --git a/cpukit/score/include/rtems/debug.h b/cpukit/score/include/rtems/debug.h
index 4155775ef2..4087e4ae94 100644
--- a/cpukit/score/include/rtems/debug.h
+++ b/cpukit/score/include/rtems/debug.h
@@ -45,25 +45,27 @@ typedef uint32_t rtems_debug_control;
SCORE_EXTERN rtems_debug_control _Debug_Level;
/**
- * This routine performs the initialization necessary for this manager.
+ * @brief Initialize Debug Manager
*/
void _Debug_Manager_initialization( void );
/**
- * This routine enables the specified types of debug checks.
+ * @brief Enable Debugging
*/
void rtems_debug_enable(
rtems_debug_control to_be_enabled
);
/**
- * This routine disables the specified types of debug checks.
+ * @brief Disable Debugging
*/
void rtems_debug_disable(
rtems_debug_control to_be_disabled
);
/**
+ * @brief Check if Debug is Enabled
+ *
* This routine returns TRUE if the requested debug level is
* enabled, and FALSE otherwise.
*/