diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-06-06 18:03:45 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2008-06-06 18:03:45 +0000 |
| commit | 8c8fd64a704ccd5958a6a426771ea533c4eb8744 (patch) | |
| tree | 0ef8fdc436a28740125d38b12a9fe39213dc5486 /cpukit/rtems/include/rtems.h | |
| parent | 2008-06-06 Joel Sherrill <joel.sherrill@OARcorp.com> (diff) | |
| download | rtems-8c8fd64a704ccd5958a6a426771ea533c4eb8744.tar.bz2 | |
2008-06-06 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/clock.h,
rtems/include/rtems/rtems/config.h,
rtems/include/rtems/rtems/dpmem.h,
rtems/include/rtems/rtems/eventset.h,
rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/part.h,
rtems/include/rtems/rtems/ratemon.h,
rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/sem.h,
rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
rtems/include/rtems/rtems/types.h, rtems/src/ratemonperiod.c: Improve
Classic API Doxygen.
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems.h | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h index 49cf5f76e0..8eb91f12fa 100644 --- a/cpukit/rtems/include/rtems.h +++ b/cpukit/rtems/include/rtems.h @@ -1,10 +1,8 @@ /** * @file rtems.h * - * This include file contains information about RTEMS executive that - * is required by the application and is CPU independent. It includes - * two (2) CPU dependent files to tailor its data structures for a - * particular processor. + * This include file provides the public interface to the RTEMS Classic + * API. */ /* COPYRIGHT (c) 1989-2008. @@ -23,7 +21,8 @@ /** * @defgroup ClassicRTEMS Classic API RTEMS Header * - * This encapsulates functionality which XXX + * This encapsulates functionality which is specific to the Classic API + * and generally shared across the various object classes. */ /**@{*/ @@ -42,7 +41,6 @@ extern "C" { * which are not included in the formally defined and supported API. * Define this at your own risk. */ - #define __RTEMS_APPLICATION__ #endif @@ -85,9 +83,9 @@ extern "C" { */ #define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP -/* - * The following define the constants which may be used in name searches. - */ +/********************************************************************** + * CONSTANTS WHICH MAY BE USED IN OBJECT NAME TO ID SEARCHES + **********************************************************************/ /** * This constant indicates that the search is across all nodes. @@ -115,9 +113,9 @@ extern "C" { */ #define RTEMS_WHO_AM_I OBJECTS_WHO_AM_I -/* - * Parameters and return id's for _Objects_Get_next - */ +/********************************************************************** + * Parameters and return Id's for _Objects_Get_next + **********************************************************************/ /** * This constant is the lowest valid valid for the index portion |