diff options
author | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-12-09 10:17:00 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2013-12-09 10:17:00 -0600 |
commit | 651e3aa8d8216e25d59225da50272c0a1fbcc90d (patch) | |
tree | 300e7a412783e02fdf8c9767778f3bd0ba80092b /cpukit/rtems/include/rtems/rtems | |
parent | arm: csb336: Add doxygen (diff) | |
download | rtems-651e3aa8d8216e25d59225da50272c0a1fbcc90d.tar.bz2 |
cpukit/rtems: Remove XXX in comments
Diffstat (limited to '')
19 files changed, 68 insertions, 53 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h index f543b5053c..bb497cffeb 100644 --- a/cpukit/rtems/include/rtems/rtems/asr.h +++ b/cpukit/rtems/include/rtems/rtems/asr.h @@ -11,7 +11,7 @@ * support required by the Signal Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -34,7 +34,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Signal + * Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/barriermp.h b/cpukit/rtems/include/rtems/rtems/barriermp.h index c497140716..24d9e1a0be 100644 --- a/cpukit/rtems/include/rtems/rtems/barriermp.h +++ b/cpukit/rtems/include/rtems/rtems/barriermp.h @@ -7,7 +7,7 @@ * with the Multiprocessing Support in the Barrier Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -29,7 +29,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Barrier Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h index c4bc79dc97..372f8f31fe 100644 --- a/cpukit/rtems/include/rtems/rtems/cache.h +++ b/cpukit/rtems/include/rtems/rtems/cache.h @@ -9,27 +9,12 @@ * Functionality Associated with the Cache Manager */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be * found in the file LICENSE in this distribution or at * http://www.rtems.com/license/LICENSE. - * - * - * The functions in this file define the API to the RTEMS Cache Manager and - * are divided into data cache and instruction cache functions. Data cache - * functions are only meaningful if a data cache is supported. Instruction - * cache functions are only meaningful if an instruction cache is supported. - * - * The functions below are implemented with CPU dependent support routines - * implemented as part of libcpu. In the event that a CPU does not support a - * specific function, the CPU dependent routine does nothing (but does exist). - * - * At this point, the Cache Manager makes no considerations, and provides no - * support for BSP specific issues such as a secondary cache. In such a system, - * the CPU dependent routines would have to be modified, or a BSP layer added - * to this Manager. */ #ifndef _RTEMS_RTEMS_CACHE_H @@ -47,7 +32,19 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * The functions in this file define the API to the RTEMS Cache Manager and + * are divided into data cache and instruction cache functions. Data cache + * functions are only meaningful if a data cache is supported. Instruction + * cache functions are only meaningful if an instruction cache is supported. + * + * The functions are implemented with CPU dependent support routines + * implemented as part of libcpu. In the event that a CPU does not support a + * specific function, the CPU dependent routine does nothing (but does exist). + * + * At this point, the Cache Manager makes no considerations, and provides no + * support for BSP specific issues such as a secondary cache. In such a system, + * the CPU dependent routines would have to be modified, or a BSP layer added + * to this Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h index ec8d8f8f70..e933a5e31a 100644 --- a/cpukit/rtems/include/rtems/rtems/clock.h +++ b/cpukit/rtems/include/rtems/rtems/clock.h @@ -19,7 +19,7 @@ * - obtain the system uptime */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -42,7 +42,8 @@ * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Clock + * Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/config.h b/cpukit/rtems/include/rtems/rtems/config.h index 3ad19ea68b..e8126ccb33 100644 --- a/cpukit/rtems/include/rtems/rtems/config.h +++ b/cpukit/rtems/include/rtems/rtems/config.h @@ -10,7 +10,7 @@ * parameters specific for the RTEMS API. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -33,7 +33,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the application's configuration + * of the Classic API including the maximum number of each class of objects. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h index d672da89c7..3ffaa91e73 100644 --- a/cpukit/rtems/include/rtems/rtems/eventmp.h +++ b/cpukit/rtems/include/rtems/rtems/eventmp.h @@ -10,7 +10,7 @@ * with the Multiprocessing Support in the Event Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -36,7 +36,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Event Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h index f80afc162a..a98d0bef0e 100644 --- a/cpukit/rtems/include/rtems/rtems/intr.h +++ b/cpukit/rtems/include/rtems/rtems/intr.h @@ -10,7 +10,7 @@ * the Interrupt Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -34,7 +34,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Interrupt + * Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 1c248857a0..054ec8057b 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -22,7 +22,7 @@ * - flush all messages on a queue */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -64,7 +64,8 @@ typedef struct { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Message Queue + * Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h index 7b07c8892f..d23032cc7b 100644 --- a/cpukit/rtems/include/rtems/rtems/modes.h +++ b/cpukit/rtems/include/rtems/rtems/modes.h @@ -10,7 +10,7 @@ * with the RTEMS thread and RTEMS_ASR modes. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -32,7 +32,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the task modes supported + * by the Classic API Task Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/mp.h b/cpukit/rtems/include/rtems/rtems/mp.h index fc59e74493..1648fcb56e 100644 --- a/cpukit/rtems/include/rtems/rtems/mp.h +++ b/cpukit/rtems/include/rtems/rtems/mp.h @@ -10,7 +10,7 @@ * with the Multiprocessing Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -26,7 +26,8 @@ * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the distributed + * Multiprocessing support in the Classic API. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h index 87ae40d349..944372113d 100644 --- a/cpukit/rtems/include/rtems/rtems/msgmp.h +++ b/cpukit/rtems/include/rtems/rtems/msgmp.h @@ -7,7 +7,7 @@ * with the Multiprocessing Support in the Message Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -33,7 +33,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Message Queue Manager. */ /*{*/ diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h index bd80cc00da..4c8a1260b2 100644 --- a/cpukit/rtems/include/rtems/rtems/object.h +++ b/cpukit/rtems/include/rtems/rtems/object.h @@ -9,7 +9,7 @@ * This include file defines Classic API interfaces to Object Services. */ -/* COPYRIGHT (c) 1989-2011. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -34,7 +34,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Object + * Class Services. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h index 4d3bf27760..28907c751a 100644 --- a/cpukit/rtems/include/rtems/rtems/partmp.h +++ b/cpukit/rtems/include/rtems/rtems/partmp.h @@ -7,7 +7,7 @@ * with the Multiprocessing Support in the Partition Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -33,7 +33,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Partition Manager. */ /*{*/ diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index 37bf82eebb..12ca41eccb 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -19,7 +19,7 @@ * - return a segment to a region */ -/* COPYRIGHT (c) 1989-2009. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -46,7 +46,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the Classic API Region + * Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index 65eb88b3b0..e6a5dff9bd 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -10,7 +10,7 @@ * with the Multiprocessing Support in the Region Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -36,7 +36,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Region Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/semmp.h b/cpukit/rtems/include/rtems/rtems/semmp.h index a3fd2d9b2e..be48187d70 100644 --- a/cpukit/rtems/include/rtems/rtems/semmp.h +++ b/cpukit/rtems/include/rtems/rtems/semmp.h @@ -10,7 +10,7 @@ * with the Multiprocessing Support in the Semaphore Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -34,7 +34,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Semaphore Manager. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h index 3d1608ed19..7cf784a5d4 100644 --- a/cpukit/rtems/include/rtems/rtems/signalmp.h +++ b/cpukit/rtems/include/rtems/rtems/signalmp.h @@ -7,7 +7,7 @@ * with the Multiprocessing Support in the Signal Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -33,7 +33,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Signal Manager. */ /*{*/ diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h index 4dad087435..2761791478 100644 --- a/cpukit/rtems/include/rtems/rtems/status.h +++ b/cpukit/rtems/include/rtems/rtems/status.h @@ -10,7 +10,7 @@ * executive directives. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -32,7 +32,8 @@ extern "C" { * * @ingroup ClassicRTEMS * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the status codes returned + * by Classic API directives. */ /**@{*/ diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h index 1bce74bda0..0096f532bd 100644 --- a/cpukit/rtems/include/rtems/rtems/taskmp.h +++ b/cpukit/rtems/include/rtems/rtems/taskmp.h @@ -10,7 +10,7 @@ * with the multiprocessing support in the task manager. */ -/* COPYRIGHT (c) 1989-2008. +/* COPYRIGHT (c) 1989-2013. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -36,7 +36,8 @@ extern "C" { * * @ingroup ClassicMP * - * This encapsulates functionality which XXX + * This encapsulates functionality related to the transparent multiprocessing + * support within the Classic API Task Manager. */ /**@{*/ |