summaryrefslogtreecommitdiffstats
path: root/cpukit/sapi/include/rtems/init.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-08 07:13:41 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2013-01-08 07:13:41 -0600
commit27f071cd88134b995f562e7080ba9820f93d48df (patch)
tree1975c04f0412b6c400eb5ce26154080af7569d0a /cpukit/sapi/include/rtems/init.h
parentlibcsupport: Doxygen Clean Up Task #1 (diff)
downloadrtems-27f071cd88134b995f562e7080ba9820f93d48df.tar.bz2
sapi: Doxygen Clean Up Task #1
Diffstat (limited to 'cpukit/sapi/include/rtems/init.h')
-rw-r--r--cpukit/sapi/include/rtems/init.h74
1 files changed, 37 insertions, 37 deletions
diff --git a/cpukit/sapi/include/rtems/init.h b/cpukit/sapi/include/rtems/init.h
index d357c113df..ad9a144910 100644
--- a/cpukit/sapi/include/rtems/init.h
+++ b/cpukit/sapi/include/rtems/init.h
@@ -1,19 +1,19 @@
/**
- * @file rtems/init.h
+ * @file
*
* @brief Constants and Structures Associated
* with the Initialization Manager
*
- * This include file contains all the constants and structures associated
- * with the Initialization Manager. This manager is responsible for
- * initializing RTEMS, creating and starting all configured initialization
- * tasks, invoking the initialization routine for each user-supplied device
- * driver, and initializing the optional multiprocessor layer.
+ * This include file contains all the constants and structures associated
+ * with the Initialization Manager. This manager is responsible for
+ * initializing RTEMS, creating and starting all configured initialization
+ * tasks, invoking the initialization routine for each user-supplied device
+ * driver, and initializing the optional multiprocessor layer.
*
- * This manager provides directives to:
+ * This manager provides directives to:
*
- * + initialize the RTEMS executive
- * + shutdown the RTEMS executive
+ * + initialize the RTEMS executive
+ * + shutdown the RTEMS executive
*/
/*
@@ -38,64 +38,64 @@ extern "C" {
#if defined(RTEMS_MULTIPROCESSING)
/**
- * The following defines the default Multiprocessing Configuration
- * Table. This table is used in a single processor system.
+ * The following defines the default Multiprocessing Configuration
+ * Table. This table is used in a single processor system.
*/
extern const rtems_multiprocessing_table
_Initialization_Default_multiprocessing_table;
#endif
/**
- * @brief rtems_initialize_data_structures
+ * @brief RTEMS data structures initialization.
*
- * This routine implements the portion of the RTEMS initializatin process
- * that involves initializing data structures to a state that scheduling
- * can occur in a consistent manner.
+ * This routine implements the portion of the RTEMS initializatin process
+ * that involves initializing data structures to a state that scheduling
+ * can occur in a consistent manner.
*/
void rtems_initialize_data_structures(void);
/**
- * @brief rtems_initialize_before_drivers
+ * @brief RTEMS initialization before the device drivers are initialized.
*
- * This routine implements the portion of RTEMS initialization that
- * is done immediately before device drivers are initialized.
+ * This routine implements the portion of RTEMS initialization that
+ * is done immediately before device drivers are initialized.
*/
void rtems_initialize_before_drivers(void);
/**
- * @brief rtems_initialize_device_drivers
+ * @brief RTEMS initialization that initializes all device drivers.
*
- * This routine implements the portion of RTEMS initialization that
- * initializes all device drivers.
+ * This routine implements the portion of RTEMS initialization that
+ * initializes all device drivers.
*/
void rtems_initialize_device_drivers(void);
/**
- * @brief Starts the multitasking.
+ * @brief Starts the multitasking.
*
- * This directive initiates multitasking and performs a context switch to the
- * first user application task and may enable interrupts as a side-effect of
- * that context switch. The context switch saves the executing context. The
- * application runs now. The directive rtems_shutdown_executive() will return
- * to the saved context. The exit() function will use this directive.
+ * This directive initiates multitasking and performs a context switch to the
+ * first user application task and may enable interrupts as a side-effect of
+ * that context switch. The context switch saves the executing context. The
+ * application runs now. The directive rtems_shutdown_executive() will return
+ * to the saved context. The exit() function will use this directive.
*
- * After a return to the saved context a fatal system state is reached. The
- * fatal source is RTEMS_FATAL_SOURCE_EXIT with a fatal code set to the value
- * passed to rtems_shutdown_executive().
+ * After a return to the saved context a fatal system state is reached. The
+ * fatal source is RTEMS_FATAL_SOURCE_EXIT with a fatal code set to the value
+ * passed to rtems_shutdown_executive().
*
- * This directive does not return.
+ * This directive does not return.
*/
void rtems_initialize_start_multitasking(void)
RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
/**
- * @brief Shutdown the RTEMS environment
+ * @brief Shutdown the RTEMS environment.
*
- * This routine implements the rtems_shutdown_executive directive. The
- * invocation of this directive results in the RTEMS environment being
- * shutdown and multitasking halted. From the application's perspective,
- * invocation of this directive results in the rtems_initialize_executive
- * directive exitting to the startup code which invoked it.
+ * This routine implements the rtems_shutdown_executive directive. The
+ * invocation of this directive results in the RTEMS environment being
+ * shutdown and multitasking halted. From the application's perspective,
+ * invocation of this directive results in the rtems_initialize_executive
+ * directive exitting to the startup code which invoked it.
*/
void rtems_shutdown_executive(
uint32_t result