diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-26 11:45:47 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
| commit | 6b5f22dcbb4a876080a3713233e4d5a23d6383ed (patch) | |
| tree | 9d509ea5c1b34eb06d728eeb95423fd7f3eefc1f /cpukit | |
| parent | score: Always define RTEMSScoreMRSP group (diff) | |
| download | rtems-6b5f22dcbb4a876080a3713233e4d5a23d6383ed.tar.bz2 | |
rtems: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions.
Update #3706.
Diffstat (limited to '')
176 files changed, 753 insertions, 388 deletions
diff --git a/cpukit/include/rtems/rtems/asrimpl.h b/cpukit/include/rtems/rtems/asrimpl.h index f007457fe5..e9369079e6 100644 --- a/cpukit/include/rtems/rtems/asrimpl.h +++ b/cpukit/include/rtems/rtems/asrimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicASR * - * @brief Classic ASR Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicASR support. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/attrimpl.h b/cpukit/include/rtems/rtems/attrimpl.h index 3b19c67387..a41b3ad89b 100644 --- a/cpukit/include/rtems/rtems/attrimpl.h +++ b/cpukit/include/rtems/rtems/attrimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicAttr * - * @brief Classic Attributes Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicAttr support. */ /* diff --git a/cpukit/include/rtems/rtems/barrierimpl.h b/cpukit/include/rtems/rtems/barrierimpl.h index 0cee8e4d74..5f96273f89 100644 --- a/cpukit/include/rtems/rtems/barrierimpl.h +++ b/cpukit/include/rtems/rtems/barrierimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicBarrier * - * @brief Classic Barrier Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicBarrier. */ /* diff --git a/cpukit/include/rtems/rtems/clockimpl.h b/cpukit/include/rtems/rtems/clockimpl.h index eff1231fb2..c13c158410 100644 --- a/cpukit/include/rtems/rtems/clockimpl.h +++ b/cpukit/include/rtems/rtems/clockimpl.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicClock * - * @brief This header file provides interfaces used by the Clock Manager - * implementation. + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicClock. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/dpmemimpl.h b/cpukit/include/rtems/rtems/dpmemimpl.h index 54324d6016..a399eccd94 100644 --- a/cpukit/include/rtems/rtems/dpmemimpl.h +++ b/cpukit/include/rtems/rtems/dpmemimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicDPMem * - * @brief Dual Ported Memory Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicDPMem */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h index 9e4f5cfa74..bd90554455 100644 --- a/cpukit/include/rtems/rtems/eventimpl.h +++ b/cpukit/include/rtems/rtems/eventimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicEvent * - * @brief This header file provides interfaces used by the event implementation. + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicEvent. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/eventmp.h b/cpukit/include/rtems/rtems/eventmp.h index acf1cf8eb8..e8c77cac24 100644 --- a/cpukit/include/rtems/rtems/eventmp.h +++ b/cpukit/include/rtems/rtems/eventmp.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicEventMP * - * This include file contains all the constants and structures associated - * with the Multiprocessing Support in the Event Manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicEventMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/messageimpl.h b/cpukit/include/rtems/rtems/messageimpl.h index 063a51e558..b9cdd0251d 100644 --- a/cpukit/include/rtems/rtems/messageimpl.h +++ b/cpukit/include/rtems/rtems/messageimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicMessage * - * @brief Classic Message Queue Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicMessage. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/modesimpl.h b/cpukit/include/rtems/rtems/modesimpl.h index 43e3fcb4d7..5a147b10b9 100644 --- a/cpukit/include/rtems/rtems/modesimpl.h +++ b/cpukit/include/rtems/rtems/modesimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicModes * - * @brief Classic Modes Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicModes support. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h index 0ddeaf7d53..2f2cd822f8 100644 --- a/cpukit/include/rtems/rtems/mp.h +++ b/cpukit/include/rtems/rtems/mp.h @@ -1,10 +1,9 @@ /** * @file * - * @ingroup ClassicMP + * @ingroup RTEMSImplClassic * - * This include file contains all the constants and structures associated - * with the Multiprocessing Manager. + * @brief This header file provides parts of the multiprocessing (MP) API. */ /* COPYRIGHT (c) 1989-2013. @@ -21,7 +20,7 @@ #include <rtems/score/mppkt.h> /** - * @defgroup ClassicMP Multiprocessing + * @defgroup RTEMSAPIClassicMP Multiprocessing * * @ingroup RTEMSAPIClassic * diff --git a/cpukit/include/rtems/rtems/msgmp.h b/cpukit/include/rtems/rtems/msgmp.h index 3b62224e03..a5f5ae8011 100644 --- a/cpukit/include/rtems/rtems/msgmp.h +++ b/cpukit/include/rtems/rtems/msgmp.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSImplClassicMessageMP * - * @brief Message Manager MP Support - * - * This include file contains all the constants and structures associated - * with the Multiprocessing Support in the Message Manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicMessageMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/objectimpl.h b/cpukit/include/rtems/rtems/objectimpl.h index ada2a5a4cb..fc93d1aa3b 100644 --- a/cpukit/include/rtems/rtems/objectimpl.h +++ b/cpukit/include/rtems/rtems/objectimpl.h @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicObject * - * @brief Implementation Interfaces for Classic Objects + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicObject. */ /* diff --git a/cpukit/include/rtems/rtems/optionsimpl.h b/cpukit/include/rtems/rtems/optionsimpl.h index 3f08978515..7130b2c31f 100644 --- a/cpukit/include/rtems/rtems/optionsimpl.h +++ b/cpukit/include/rtems/rtems/optionsimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicOptions * - * @brief Classic Options Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicOptions support. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/partimpl.h b/cpukit/include/rtems/rtems/partimpl.h index 3e2b1e759e..144265df7d 100644 --- a/cpukit/include/rtems/rtems/partimpl.h +++ b/cpukit/include/rtems/rtems/partimpl.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicPartition * - * @brief This header file provides interfaces used by the Partition Manager - * implementation. + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicPartition. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/partmp.h b/cpukit/include/rtems/rtems/partmp.h index 5e2ed77285..103a28f9d5 100644 --- a/cpukit/include/rtems/rtems/partmp.h +++ b/cpukit/include/rtems/rtems/partmp.h @@ -3,10 +3,8 @@ * * @ingroup RTEMSImplClassicPartitionMP * - * @brief MP Support in Partition Manager - * - * This include file contains all the constants and structures associated - * with the Multiprocessing Support in the Partition Manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicPartitionMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/ratemonimpl.h b/cpukit/include/rtems/rtems/ratemonimpl.h index 998fa386bf..7e42a0437c 100644 --- a/cpukit/include/rtems/rtems/ratemonimpl.h +++ b/cpukit/include/rtems/rtems/ratemonimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicRateMonotonic * - * @brief Classic Rate Monotonic Scheduler Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicRateMonotonic. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/regionimpl.h b/cpukit/include/rtems/rtems/regionimpl.h index 418d5d052d..85facea5e7 100644 --- a/cpukit/include/rtems/rtems/regionimpl.h +++ b/cpukit/include/rtems/rtems/regionimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicRegion * - * @brief Classic Region Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicRegion. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/semimpl.h b/cpukit/include/rtems/rtems/semimpl.h index c84c3d2a76..2f76d73d16 100644 --- a/cpukit/include/rtems/rtems/semimpl.h +++ b/cpukit/include/rtems/rtems/semimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicSemaphore * - * @brief Classic Semaphore Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicSemaphore. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/semmp.h b/cpukit/include/rtems/rtems/semmp.h index a516b111e2..e69d338ddd 100644 --- a/cpukit/include/rtems/rtems/semmp.h +++ b/cpukit/include/rtems/rtems/semmp.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicSemaphoreMP * - * This include file contains all the constants and structures associated - * with the Multiprocessing Support in the Semaphore Manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicSemaphoreMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/signalimpl.h b/cpukit/include/rtems/rtems/signalimpl.h index 282b29fb48..51f742c9fe 100644 --- a/cpukit/include/rtems/rtems/signalimpl.h +++ b/cpukit/include/rtems/rtems/signalimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicSignal * - * @brief Signals Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicSignal. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/signalmp.h b/cpukit/include/rtems/rtems/signalmp.h index 240a271755..8e1fb06003 100644 --- a/cpukit/include/rtems/rtems/signalmp.h +++ b/cpukit/include/rtems/rtems/signalmp.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicSignalMP * - * This include file contains all the constants and structures associated - * with the Multiprocessing Support in the Signal Manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicSignalMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/statusimpl.h b/cpukit/include/rtems/rtems/statusimpl.h index fc67fb6768..070c612202 100644 --- a/cpukit/include/rtems/rtems/statusimpl.h +++ b/cpukit/include/rtems/rtems/statusimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicStatus * - * @brief Classic Status Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicStatus support. */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/include/rtems/rtems/taskmp.h b/cpukit/include/rtems/rtems/taskmp.h index d0f4b6f6ee..d991df0c51 100644 --- a/cpukit/include/rtems/rtems/taskmp.h +++ b/cpukit/include/rtems/rtems/taskmp.h @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicTaskMP * - * This include file contains all the constants and structures associated - * with the multiprocessing support in the task manager. + * @brief This header file provides the implementation interfaces of the + * @ref RTEMSImplClassicTaskMP. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/include/rtems/rtems/tasksimpl.h b/cpukit/include/rtems/rtems/tasksimpl.h index fc9d1e04f8..eac4647897 100644 --- a/cpukit/include/rtems/rtems/tasksimpl.h +++ b/cpukit/include/rtems/rtems/tasksimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicTask * - * @brief Classic Tasks Manager Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicTask. */ /* COPYRIGHT (c) 1989-2014. diff --git a/cpukit/include/rtems/rtems/timerimpl.h b/cpukit/include/rtems/rtems/timerimpl.h index 5305aa064a..c441a040e6 100644 --- a/cpukit/include/rtems/rtems/timerimpl.h +++ b/cpukit/include/rtems/rtems/timerimpl.h @@ -3,7 +3,8 @@ * * @ingroup RTEMSImplClassicTimer * - * @brief Classic Timer Implementation + * @brief This header file provides the implementation interfaces of + * the @ref RTEMSImplClassicTimer. */ /* diff --git a/cpukit/rtems/src/barrier.c b/cpukit/rtems/src/barrier.c index bcfcf270e9..5f8bf51064 100644 --- a/cpukit/rtems/src/barrier.c +++ b/cpukit/rtems/src/barrier.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicBarrier + * @ingroup RTEMSImplClassicBarrier * - * @brief Classic Barrier Information with Zero Objects + * @brief This source file contains a definition of the ::_Barrier_Information + * with zero objects. */ /* diff --git a/cpukit/rtems/src/barriercreate.c b/cpukit/rtems/src/barriercreate.c index 74cedab27a..6e6b294832 100644 --- a/cpukit/rtems/src/barriercreate.c +++ b/cpukit/rtems/src/barriercreate.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicBarrier Barriers + * @ingroup RTEMSImplClassicBarrier * - * @brief RTEMS Create Barrier + * @brief This source file contains the implementation of + * rtems_barrier_create() and the Barrier Manager system initialization. */ /* diff --git a/cpukit/rtems/src/barrierdelete.c b/cpukit/rtems/src/barrierdelete.c index b35b2f1fca..b39659a3f8 100644 --- a/cpukit/rtems/src/barrierdelete.c +++ b/cpukit/rtems/src/barrierdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Barrier - * @ingroup ClassicBarrier + * @ingroup RTEMSImplClassicBarrier + * + * @brief This source file contains the implementation of + * rtems_barrier_delete(). */ /* diff --git a/cpukit/rtems/src/barrierident.c b/cpukit/rtems/src/barrierident.c index 1cff99829d..28ab94957f 100644 --- a/cpukit/rtems/src/barrierident.c +++ b/cpukit/rtems/src/barrierident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicBarrier * - * @brief rtems_barrier_ident() Implementation + * @brief This source file contains the implementation of + * rtems_barrier_ident(). */ /* diff --git a/cpukit/rtems/src/barrierrelease.c b/cpukit/rtems/src/barrierrelease.c index 801c07afcb..efc10aa6e1 100644 --- a/cpukit/rtems/src/barrierrelease.c +++ b/cpukit/rtems/src/barrierrelease.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicBarrier Barriers + * @ingroup RTEMSImplClassicBarrier * - * @brief RTEMS Barrier Release + * @brief This source file contains the implementation of + * rtems_barrier_release(). */ /* diff --git a/cpukit/rtems/src/barrierwait.c b/cpukit/rtems/src/barrierwait.c index 51fcd6675e..ff2a6a1ca7 100644 --- a/cpukit/rtems/src/barrierwait.c +++ b/cpukit/rtems/src/barrierwait.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Barrier Wait - * @ingroup ClassicBarrier + * @ingroup RTEMSImplClassicBarrier + * + * @brief This source file contains the implementation of + * rtems_barrier_wait(). */ /* diff --git a/cpukit/rtems/src/clockgetsecondssinceepoch.c b/cpukit/rtems/src/clockgetsecondssinceepoch.c index 1c2cb23051..2747bb9673 100644 --- a/cpukit/rtems/src/clockgetsecondssinceepoch.c +++ b/cpukit/rtems/src/clockgetsecondssinceepoch.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Obtain Seconds Since Epoch - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_get_seconds_since_epoch(). */ /* diff --git a/cpukit/rtems/src/clockgettickspersecond.c b/cpukit/rtems/src/clockgettickspersecond.c index ecfe5fa8b6..9fc1f0d9e0 100644 --- a/cpukit/rtems/src/clockgettickspersecond.c +++ b/cpukit/rtems/src/clockgettickspersecond.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Obtain Ticks Per Seconds - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_get_ticks_per_second(). */ /* diff --git a/cpukit/rtems/src/clockgettod.c b/cpukit/rtems/src/clockgettod.c index 4610c6a519..dea136d477 100644 --- a/cpukit/rtems/src/clockgettod.c +++ b/cpukit/rtems/src/clockgettod.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClock Clocks + * @ingroup RTEMSImplClassicClock * - * @brief Obtain Current Time of Day (Classic TOD) + * @brief This source file contains the implementation of + * rtems_clock_get_tod(). */ /* diff --git a/cpukit/rtems/src/clockgettodtimeval.c b/cpukit/rtems/src/clockgettodtimeval.c index d807ade2ea..bf3847afec 100644 --- a/cpukit/rtems/src/clockgettodtimeval.c +++ b/cpukit/rtems/src/clockgettodtimeval.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Obtain TOD in struct timeval Format - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_get_tod_timeval(). */ /* diff --git a/cpukit/rtems/src/clockgetuptime.c b/cpukit/rtems/src/clockgetuptime.c index b79745b035..523cc910b9 100644 --- a/cpukit/rtems/src/clockgetuptime.c +++ b/cpukit/rtems/src/clockgetuptime.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClock Clocks + * @ingroup RTEMSImplClassicClock * - * @brief Obtain the System Uptime + * @brief This source file contains the implementation of + * rtems_clock_get_uptime(). */ /* diff --git a/cpukit/rtems/src/clockgetuptimenanoseconds.c b/cpukit/rtems/src/clockgetuptimenanoseconds.c index 3eb1a2daea..8d6d90ca38 100644 --- a/cpukit/rtems/src/clockgetuptimenanoseconds.c +++ b/cpukit/rtems/src/clockgetuptimenanoseconds.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClock Clocks + * @ingroup RTEMSImplClassicClock * - * @brief Returns the system uptime in seconds. + * @brief This source file contains the implementation of + * rtems_clock_get_uptime_nanoseconds(). */ /* diff --git a/cpukit/rtems/src/clockgetuptimeseconds.c b/cpukit/rtems/src/clockgetuptimeseconds.c index ad412b2234..5411c1bb9f 100644 --- a/cpukit/rtems/src/clockgetuptimeseconds.c +++ b/cpukit/rtems/src/clockgetuptimeseconds.c @@ -1,7 +1,10 @@ /** * @file * - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_get_uptime_seconds(). */ /* diff --git a/cpukit/rtems/src/clockgetuptimetimeval.c b/cpukit/rtems/src/clockgetuptimetimeval.c index 6fdc0d22c9..1a1e8298ea 100644 --- a/cpukit/rtems/src/clockgetuptimetimeval.c +++ b/cpukit/rtems/src/clockgetuptimetimeval.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Gets the System Uptime in the Struct Timeval Format - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_get_uptime_timeval(). */ /* diff --git a/cpukit/rtems/src/clockset.c b/cpukit/rtems/src/clockset.c index 58503394fd..a4a3cd1507 100644 --- a/cpukit/rtems/src/clockset.c +++ b/cpukit/rtems/src/clockset.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Set the Current TOD - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_set(). */ /* diff --git a/cpukit/rtems/src/clocktick.c b/cpukit/rtems/src/clocktick.c index 568610a427..248870a625 100644 --- a/cpukit/rtems/src/clocktick.c +++ b/cpukit/rtems/src/clocktick.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Announce a Clock Tick - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * rtems_clock_tick(). */ /* diff --git a/cpukit/rtems/src/clocktodtoseconds.c b/cpukit/rtems/src/clocktodtoseconds.c index d1a80170b2..49ae257243 100644 --- a/cpukit/rtems/src/clocktodtoseconds.c +++ b/cpukit/rtems/src/clocktodtoseconds.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief TOD to Seconds - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * _TOD_To_seconds(). */ /* diff --git a/cpukit/rtems/src/clocktodvalidate.c b/cpukit/rtems/src/clocktodvalidate.c index a0f841686c..d8af275d04 100644 --- a/cpukit/rtems/src/clocktodvalidate.c +++ b/cpukit/rtems/src/clocktodvalidate.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief TOD Validate - * @ingroup ClassicClock + * @ingroup RTEMSImplClassicClock + * + * @brief This source file contains the implementation of + * _TOD_Validate(). */ /* diff --git a/cpukit/rtems/src/dpmem.c b/cpukit/rtems/src/dpmem.c index 10a11374c0..a30033c2f3 100644 --- a/cpukit/rtems/src/dpmem.c +++ b/cpukit/rtems/src/dpmem.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicDPMEM + * @ingroup RTEMSImplClassicDPMem * - * @brief Classic Dual Ported Memory Information with Zero Objects + * @brief This source file contains a definition of + * ::_Dual_ported_memory_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/dpmemcreate.c b/cpukit/rtems/src/dpmemcreate.c index 104d0a8146..bc14de19c8 100644 --- a/cpukit/rtems/src/dpmemcreate.c +++ b/cpukit/rtems/src/dpmemcreate.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief RTEMS Create Port - * @ingroup ClassicDPMEM + * @ingroup RTEMSImplClassicDPMem + * + * @brief This source file contains the implementation of + * rtems_port_create() and the Dual-Ported Memory Manager system + * initialization. */ /* diff --git a/cpukit/rtems/src/dpmemdelete.c b/cpukit/rtems/src/dpmemdelete.c index f565f9471b..6137b9ea23 100644 --- a/cpukit/rtems/src/dpmemdelete.c +++ b/cpukit/rtems/src/dpmemdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Port - * @ingroup ClassicDPMEM + * @ingroup RTEMSImplClassicDPMem + * + * @brief This source file contains the implementation of + * rtems_port_delete(). */ /* diff --git a/cpukit/rtems/src/dpmemexternal2internal.c b/cpukit/rtems/src/dpmemexternal2internal.c index dda5139fca..8044044519 100644 --- a/cpukit/rtems/src/dpmemexternal2internal.c +++ b/cpukit/rtems/src/dpmemexternal2internal.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Port External to Internal - * @ingroup ClassicDPMEM + * @ingroup RTEMSImplClassicDPMem + * + * @brief This source file contains the implementation of + * rtems_port_external_to_internal(). */ /* diff --git a/cpukit/rtems/src/dpmemident.c b/cpukit/rtems/src/dpmemident.c index 679933a770..7286cc1366 100644 --- a/cpukit/rtems/src/dpmemident.c +++ b/cpukit/rtems/src/dpmemident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicDPMem * - * @brief rtems_port_ident() Implementation + * @brief This source file contains the implementation of + * rtems_port_ident(). */ /* diff --git a/cpukit/rtems/src/dpmeminternal2external.c b/cpukit/rtems/src/dpmeminternal2external.c index 5694e5e387..81bb11619d 100644 --- a/cpukit/rtems/src/dpmeminternal2external.c +++ b/cpukit/rtems/src/dpmeminternal2external.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Port Internal to External - * @ingroup ClassicDPMEM + * @ingroup RTEMSImplClassicDPMem + * + * @brief This source file contains the implementation of + * rtems_port_internal_to_external(). */ /* diff --git a/cpukit/rtems/src/eventmp.c b/cpukit/rtems/src/eventmp.c index d1968d3e98..6676c2461d 100644 --- a/cpukit/rtems/src/eventmp.c +++ b/cpukit/rtems/src/eventmp.c @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicEventMP * - * @brief This source file contains the implementation of the task event MPCI - * support. + * @brief This source file contains the implementation to support the Event + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/eventseize.c b/cpukit/rtems/src/eventseize.c index 9574ba13ec..3b920c0fc8 100644 --- a/cpukit/rtems/src/eventseize.c +++ b/cpukit/rtems/src/eventseize.c @@ -4,7 +4,8 @@ * @ingroup RTEMSImplClassicEvent * * @brief This source file contains the implementation of - * _Event_Seize() and the task event MPCI support system initialization. + * _Event_Seize() and the Event Manager multiprocessing (MP) support system + * initialization. */ /* diff --git a/cpukit/rtems/src/getapiconfig.c b/cpukit/rtems/src/getapiconfig.c index 2e94526e10..11eb443496 100644 --- a/cpukit/rtems/src/getapiconfig.c +++ b/cpukit/rtems/src/getapiconfig.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_api_configuration_table(). + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/rtems/src/intrbody.c b/cpukit/rtems/src/intrbody.c index fd77783a94..d114749275 100644 --- a/cpukit/rtems/src/intrbody.c +++ b/cpukit/rtems/src/intrbody.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief RTEMS Interrupt Support - * @ingroup ClassicINTR + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * directive bindings of the Interrupt Manager for languages other than + * C/C++. */ /* diff --git a/cpukit/rtems/src/intrcatch.c b/cpukit/rtems/src/intrcatch.c index 9083af1eaf..3bd857ace3 100644 --- a/cpukit/rtems/src/intrcatch.c +++ b/cpukit/rtems/src/intrcatch.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Interrupt Catch - * @ingroup ClassicINTR + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_interrupt_catch(). */ /* diff --git a/cpukit/rtems/src/modes.c b/cpukit/rtems/src/modes.c index 77d3d97233..0bf9575abe 100644 --- a/cpukit/rtems/src/modes.c +++ b/cpukit/rtems/src/modes.c @@ -1,11 +1,13 @@ /** - * @file + * @file * - * @brief Body for RTEMS_INTERRUPT_LEVEL Macro - * @ingroup ClassicModes + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_interrupt_level_body() and the definition of ::rtems_interrupt_mask + * to support languages other than C/C++. */ - /* * COPYRIGHT (c) 1989-2012. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/rtems/src/mp.c b/cpukit/rtems/src/mp.c index d2cca9cb63..0730dc54eb 100644 --- a/cpukit/rtems/src/mp.c +++ b/cpukit/rtems/src/mp.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief MP Support - * @ingroup ClassicMP + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation to support the Classic + * API in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/msg.c b/cpukit/rtems/src/msg.c index ea09af9e7a..a606e3ebe0 100644 --- a/cpukit/rtems/src/msg.c +++ b/cpukit/rtems/src/msg.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage * - * @brief Classic Message Queue Information with Zero Objects + * @brief This source file contains a definition of the + * ::_Message_queue_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/msgmp.c b/cpukit/rtems/src/msgmp.c index 9847cbd569..24143dd1e9 100644 --- a/cpukit/rtems/src/msgmp.c +++ b/cpukit/rtems/src/msgmp.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMsgMP Message Queue MP Support + * @ingroup RTEMSImplClassicMessageMP * - * @brief Multiprocessing Support for the Message Queue Manager + * @brief This source file contains the implementation to support the Message + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/msgqbroadcast.c b/cpukit/rtems/src/msgqbroadcast.c index 7b4efb9803..283d02d2a3 100644 --- a/cpukit/rtems/src/msgqbroadcast.c +++ b/cpukit/rtems/src/msgqbroadcast.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Broadcast Message Queue - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage + * + * @brief This source file contains the implementation of + * rtems_message_queue_broadcast(). */ /* diff --git a/cpukit/rtems/src/msgqconstruct.c b/cpukit/rtems/src/msgqconstruct.c index 82f6d2dfad..af5849b0aa 100644 --- a/cpukit/rtems/src/msgqconstruct.c +++ b/cpukit/rtems/src/msgqconstruct.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Create Message Queue - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage + * + * @brief This source file contains the implementation of + * rtems_message_queue_construct(). */ /* diff --git a/cpukit/rtems/src/msgqdelete.c b/cpukit/rtems/src/msgqdelete.c index e1d57addc9..82708dd072 100644 --- a/cpukit/rtems/src/msgqdelete.c +++ b/cpukit/rtems/src/msgqdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Message Queue - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage + * + * @brief This source file contains the implementation of + * rtems_message_queue_delete(). */ /* diff --git a/cpukit/rtems/src/msgqflush.c b/cpukit/rtems/src/msgqflush.c index 010ad0aa6d..a71db668ef 100644 --- a/cpukit/rtems/src/msgqflush.c +++ b/cpukit/rtems/src/msgqflush.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMessageQueue Message Queues + * @ingroup RTEMSImplClassicMessage * - * @brief rtems_message_queue_flush + * @brief This source file contains the implementation of + * rtems_message_queue_flush(). */ /* diff --git a/cpukit/rtems/src/msgqgetnumberpending.c b/cpukit/rtems/src/msgqgetnumberpending.c index 0b95ca9eeb..15b960a36f 100644 --- a/cpukit/rtems/src/msgqgetnumberpending.c +++ b/cpukit/rtems/src/msgqgetnumberpending.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMessageQueue Message Queues + * @ingroup RTEMSImplClassicMessage * - * @brief RTEMS Message Queue Get Number Pending + * @brief This source file contains the implementation of + * rtems_message_queue_get_number_pending(). */ /* diff --git a/cpukit/rtems/src/msgqident.c b/cpukit/rtems/src/msgqident.c index fd5728d51e..a6c58ee4cb 100644 --- a/cpukit/rtems/src/msgqident.c +++ b/cpukit/rtems/src/msgqident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicMessage * - * @brief rtems_message_queue_ident() Implementation + * @brief This source file contains the implementation of + * rtems_message_queue_ident(). */ /* diff --git a/cpukit/rtems/src/msgqreceive.c b/cpukit/rtems/src/msgqreceive.c index 2b0d18d923..9a55afbad0 100644 --- a/cpukit/rtems/src/msgqreceive.c +++ b/cpukit/rtems/src/msgqreceive.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Message Queue Receive - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage + * + * @brief This source file contains the implementation of + * rtems_message_queue_receive(). */ /* diff --git a/cpukit/rtems/src/msgqsend.c b/cpukit/rtems/src/msgqsend.c index 2ddba4d0a6..a8a0a2fb21 100644 --- a/cpukit/rtems/src/msgqsend.c +++ b/cpukit/rtems/src/msgqsend.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicMessageQueue Message Queues + * @ingroup RTEMSImplClassicMessage * - * @brief rtems_message_queue_send + * @brief This source file contains the implementation of + * rtems_message_queue_send(). */ /* diff --git a/cpukit/rtems/src/msgqurgent.c b/cpukit/rtems/src/msgqurgent.c index 8c9557c70e..95f14b2248 100644 --- a/cpukit/rtems/src/msgqurgent.c +++ b/cpukit/rtems/src/msgqurgent.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Urgent Message Queue - * @ingroup ClassicMessageQueue + * @ingroup RTEMSImplClassicMessage + * + * @brief This source file contains the implementation of + * rtems_message_queue_urgent(). */ /* diff --git a/cpukit/rtems/src/part.c b/cpukit/rtems/src/part.c index 8fcfdf546d..992b3a2fce 100644 --- a/cpukit/rtems/src/part.c +++ b/cpukit/rtems/src/part.c @@ -3,8 +3,8 @@ * * @ingroup RTEMSImplClassicPartition * - * @brief This source file contains a definition of ::_Partition_Information - * with zero objects. + * @brief This source file contains a definition of the + * ::_Partition_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/partcreate.c b/cpukit/rtems/src/partcreate.c index ca8e4693b8..205a31620e 100644 --- a/cpukit/rtems/src/partcreate.c +++ b/cpukit/rtems/src/partcreate.c @@ -4,7 +4,7 @@ * @ingroup RTEMSImplClassicPartition * * @brief This source file contains the implementation of - * rtems_partition_create(). + * rtems_partition_create() and the Partition Manager system initialization. */ /* diff --git a/cpukit/rtems/src/partmp.c b/cpukit/rtems/src/partmp.c index f97c3373c8..27578a3401 100644 --- a/cpukit/rtems/src/partmp.c +++ b/cpukit/rtems/src/partmp.c @@ -1,10 +1,10 @@ /** * @file * - * @ingroup ClassicPartMP + * @ingroup RTEMSImplClassicPartitionMP * - * @brief This source file contains the implementation of the Partition Manager - * MPCI support. + * @brief This source file contains the implementation to support the Partition + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/ratemon.c b/cpukit/rtems/src/ratemon.c index 255fc8b2df..3e5c77b2c7 100644 --- a/cpukit/rtems/src/ratemon.c +++ b/cpukit/rtems/src/ratemon.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic * - * @brief Classic Rate Monotonic Information with Zero Objects + * @brief This source file contains a definition of the + * ::_Rate_monotonic_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/ratemoncancel.c b/cpukit/rtems/src/ratemoncancel.c index 37648eef90..3d95c06fd7 100644 --- a/cpukit/rtems/src/ratemoncancel.c +++ b/cpukit/rtems/src/ratemoncancel.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Rate Monotonic Cancel - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_cancel(). */ /* diff --git a/cpukit/rtems/src/ratemoncreate.c b/cpukit/rtems/src/ratemoncreate.c index 3eff5f0716..09f7806a05 100644 --- a/cpukit/rtems/src/ratemoncreate.c +++ b/cpukit/rtems/src/ratemoncreate.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRateMon Rate Monotonic Scheduler + * @ingroup RTEMSImplClassicRateMonotonic * - * @brief Create a Period + * @brief This source file contains the implementation of + * rtems_rate_monotonic_create(). */ /* diff --git a/cpukit/rtems/src/ratemondelete.c b/cpukit/rtems/src/ratemondelete.c index 385d08fda9..541287569a 100644 --- a/cpukit/rtems/src/ratemondelete.c +++ b/cpukit/rtems/src/ratemondelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Rate Monotonic - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_delete(). */ /* diff --git a/cpukit/rtems/src/ratemongetstatistics.c b/cpukit/rtems/src/ratemongetstatistics.c index 1646b58bb7..ec8360fe12 100644 --- a/cpukit/rtems/src/ratemongetstatistics.c +++ b/cpukit/rtems/src/ratemongetstatistics.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Rate Monotonic Get Statistics - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_get_statistics(). */ /* diff --git a/cpukit/rtems/src/ratemongetstatus.c b/cpukit/rtems/src/ratemongetstatus.c index 438d61bd5b..745b52f026 100644 --- a/cpukit/rtems/src/ratemongetstatus.c +++ b/cpukit/rtems/src/ratemongetstatus.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Rate Monotonic Get Status - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_get_status(). */ /* diff --git a/cpukit/rtems/src/ratemonident.c b/cpukit/rtems/src/ratemonident.c index 8a62f2752c..f11180dc66 100644 --- a/cpukit/rtems/src/ratemonident.c +++ b/cpukit/rtems/src/ratemonident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicRateMonotonic * - * @brief rtems_rate_monotonic_ident() Implementation + * @brief This source file contains the implementation of + * rtems_rate_monotonic_ident(). */ /* diff --git a/cpukit/rtems/src/ratemonperiod.c b/cpukit/rtems/src/ratemonperiod.c index 438e4b8412..2c55eb089d 100644 --- a/cpukit/rtems/src/ratemonperiod.c +++ b/cpukit/rtems/src/ratemonperiod.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Rate Monotonic Support - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_period_states(). */ /* diff --git a/cpukit/rtems/src/ratemonreportstatistics.c b/cpukit/rtems/src/ratemonreportstatistics.c index cf04a787e3..f3610baae0 100644 --- a/cpukit/rtems/src/ratemonreportstatistics.c +++ b/cpukit/rtems/src/ratemonreportstatistics.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Report Rate Monotonic Statistics - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * rtems_rate_monotonic_report_statistics_with_plugin(). */ /* diff --git a/cpukit/rtems/src/ratemonresetall.c b/cpukit/rtems/src/ratemonresetall.c index 978a33ace7..f1cdaf9449 100644 --- a/cpukit/rtems/src/ratemonresetall.c +++ b/cpukit/rtems/src/ratemonresetall.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRateMon Rate Monotonic Scheduler + * @ingroup RTEMSImplClassicRateMonotonic * - * @brief rtems_rate_monotonic_reset_all_statistics + * @brief This source file contains the implementation of + * rtems_rate_monotonic_reset_all_statistics(). */ /* diff --git a/cpukit/rtems/src/ratemonresetstatistics.c b/cpukit/rtems/src/ratemonresetstatistics.c index 4567451a18..841781550b 100644 --- a/cpukit/rtems/src/ratemonresetstatistics.c +++ b/cpukit/rtems/src/ratemonresetstatistics.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRateMon Rate Monotonic Scheduler + * @ingroup RTEMSImplClassicRateMonotonic * - * @brief RTEMS Rate Monotonic Reset Statistics + * @brief This source file contains the implementation of + * rtems_rate_monotonic_reset_statistics(). */ /* diff --git a/cpukit/rtems/src/ratemontimeout.c b/cpukit/rtems/src/ratemontimeout.c index 51e68751ba..b20e1e15db 100644 --- a/cpukit/rtems/src/ratemontimeout.c +++ b/cpukit/rtems/src/ratemontimeout.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Rate Monotonic Timeout - * @ingroup ClassicRateMon + * @ingroup RTEMSImplClassicRateMonotonic + * + * @brief This source file contains the implementation of + * _Rate_monotonic_Timeout(). */ /* diff --git a/cpukit/rtems/src/region.c b/cpukit/rtems/src/region.c index c9d75a89ca..b22640e5e7 100644 --- a/cpukit/rtems/src/region.c +++ b/cpukit/rtems/src/region.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion * - * @brief Classic Region Information with Zero Objects + * @brief This source file contains a definition of the ::_Region_Information + * with zero objects. */ /* diff --git a/cpukit/rtems/src/regioncreate.c b/cpukit/rtems/src/regioncreate.c index 99752193ce..d05d37aec4 100644 --- a/cpukit/rtems/src/regioncreate.c +++ b/cpukit/rtems/src/regioncreate.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicRegion Regions + * @ingroup RTEMSImplClassicRegion * - * @brief rtems_region_create + * @brief This source file contains the implementation of + * rtems_region_create() and the Region Manager system initialization. */ /* diff --git a/cpukit/rtems/src/regiondelete.c b/cpukit/rtems/src/regiondelete.c index 25021b9399..8b7e523680 100644 --- a/cpukit/rtems/src/regiondelete.c +++ b/cpukit/rtems/src/regiondelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Region - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_delete(). */ /* diff --git a/cpukit/rtems/src/regionextend.c b/cpukit/rtems/src/regionextend.c index f9a70fcb10..041215ce51 100644 --- a/cpukit/rtems/src/regionextend.c +++ b/cpukit/rtems/src/regionextend.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Extend Region - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_extend(). */ /* diff --git a/cpukit/rtems/src/regiongetfreeinfo.c b/cpukit/rtems/src/regiongetfreeinfo.c index e0f1aa4e58..90cc221922 100644 --- a/cpukit/rtems/src/regiongetfreeinfo.c +++ b/cpukit/rtems/src/regiongetfreeinfo.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Region Free Information - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_get_free_information(). */ /* diff --git a/cpukit/rtems/src/regiongetinfo.c b/cpukit/rtems/src/regiongetinfo.c index 09b31b0b6d..3ef7aa24c9 100644 --- a/cpukit/rtems/src/regiongetinfo.c +++ b/cpukit/rtems/src/regiongetinfo.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Region Information - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_get_information(). */ /* diff --git a/cpukit/rtems/src/regiongetsegment.c b/cpukit/rtems/src/regiongetsegment.c index 22f8df21cf..9b210d1126 100644 --- a/cpukit/rtems/src/regiongetsegment.c +++ b/cpukit/rtems/src/regiongetsegment.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Region Segment - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_get_segment(). */ /* diff --git a/cpukit/rtems/src/regiongetsegmentsize.c b/cpukit/rtems/src/regiongetsegmentsize.c index c232a66ccd..4ce61ddfbe 100644 --- a/cpukit/rtems/src/regiongetsegmentsize.c +++ b/cpukit/rtems/src/regiongetsegmentsize.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Region Segment Size - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_get_segment_size(). */ /* diff --git a/cpukit/rtems/src/regionident.c b/cpukit/rtems/src/regionident.c index 3eadd4afad..9bbb45df4f 100644 --- a/cpukit/rtems/src/regionident.c +++ b/cpukit/rtems/src/regionident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicRegion * - * @brief rtems_region_ident() Implementation + * @brief This source file contains the implementation of + * rtems_region_ident(). */ /* diff --git a/cpukit/rtems/src/regionprocessqueue.c b/cpukit/rtems/src/regionprocessqueue.c index 4adaf66674..6483d6cfdb 100644 --- a/cpukit/rtems/src/regionprocessqueue.c +++ b/cpukit/rtems/src/regionprocessqueue.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Process Region Queue - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * _Region_Process_queue(). */ /* diff --git a/cpukit/rtems/src/regionresizesegment.c b/cpukit/rtems/src/regionresizesegment.c index 392186889a..245064653b 100644 --- a/cpukit/rtems/src/regionresizesegment.c +++ b/cpukit/rtems/src/regionresizesegment.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Resize RTEMS Region Segment - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_resize_segment(). */ /* diff --git a/cpukit/rtems/src/regionreturnsegment.c b/cpukit/rtems/src/regionreturnsegment.c index 548f5dd4a0..38b1b16f2e 100644 --- a/cpukit/rtems/src/regionreturnsegment.c +++ b/cpukit/rtems/src/regionreturnsegment.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Return Region Segment - * @ingroup ClassicRegion + * @ingroup RTEMSImplClassicRegion + * + * @brief This source file contains the implementation of + * rtems_region_return_segment(). */ /* diff --git a/cpukit/rtems/src/rtemsbuildid.c b/cpukit/rtems/src/rtemsbuildid.c index b8a375a33c..ec3a715473 100644 --- a/cpukit/rtems/src/rtemsbuildid.c +++ b/cpukit/rtems/src/rtemsbuildid.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClassInfo Object Class Information + * @ingroup RTEMSImplClassicObject * - * @brief Build Object Id + * @brief This source file contains the implementation of + * rtems_build_id() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsbuildname.c b/cpukit/rtems/src/rtemsbuildname.c index a442b68bc9..42c8c46fd3 100644 --- a/cpukit/rtems/src/rtemsbuildname.c +++ b/cpukit/rtems/src/rtemsbuildname.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Build Thirty-Two Bit Object Name - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_build_name() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsmaxprio.c b/cpukit/rtems/src/rtemsmaxprio.c index 1ed5166962..5ecfcc5c96 100644 --- a/cpukit/rtems/src/rtemsmaxprio.c +++ b/cpukit/rtems/src/rtemsmaxprio.c @@ -2,6 +2,9 @@ * @file * * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * _RTEMS_Maximum_priority(). */ /* diff --git a/cpukit/rtems/src/rtemsnametoid.c b/cpukit/rtems/src/rtemsnametoid.c index 7fc778ba8c..d9b374bc3c 100644 --- a/cpukit/rtems/src/rtemsnametoid.c +++ b/cpukit/rtems/src/rtemsnametoid.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicObject * - * @brief _RTEMS_Name_to_id() Implementation + * @brief This source file contains the implementation of + * _RTEMS_Name_to_id(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectapimaximumclass.c b/cpukit/rtems/src/rtemsobjectapimaximumclass.c index 99f0b7975f..6c014cefcf 100644 --- a/cpukit/rtems/src/rtemsobjectapimaximumclass.c +++ b/cpukit/rtems/src/rtemsobjectapimaximumclass.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Highest Valid Class Value - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_api_maximum_class(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectapiminimumclass.c b/cpukit/rtems/src/rtemsobjectapiminimumclass.c index 1e3501c065..eb9217f4de 100644 --- a/cpukit/rtems/src/rtemsobjectapiminimumclass.c +++ b/cpukit/rtems/src/rtemsobjectapiminimumclass.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClassInfo Object Class Information + * @ingroup RTEMSImplClassicObject * - * @brief Get Lowest Valid Class Value + * @brief This source file contains the implementation of + * rtems_object_api_minimum_class(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectgetapiclassname.c b/cpukit/rtems/src/rtemsobjectgetapiclassname.c index 1f2952765d..f2c7df047d 100644 --- a/cpukit/rtems/src/rtemsobjectgetapiclassname.c +++ b/cpukit/rtems/src/rtemsobjectgetapiclassname.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Class Name - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_get_api_class_name(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectgetapiname.c b/cpukit/rtems/src/rtemsobjectgetapiname.c index 3a5d1da56d..8a142f8354 100644 --- a/cpukit/rtems/src/rtemsobjectgetapiname.c +++ b/cpukit/rtems/src/rtemsobjectgetapiname.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get API Name - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_get_api_name(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectgetclassicname.c b/cpukit/rtems/src/rtemsobjectgetclassicname.c index 3decbb10cc..52d4f8474b 100644 --- a/cpukit/rtems/src/rtemsobjectgetclassicname.c +++ b/cpukit/rtems/src/rtemsobjectgetclassicname.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Obtain Name of Object - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_get_classic_name(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectgetclassinfo.c b/cpukit/rtems/src/rtemsobjectgetclassinfo.c index 9b413da98c..dcb7ee3413 100644 --- a/cpukit/rtems/src/rtemsobjectgetclassinfo.c +++ b/cpukit/rtems/src/rtemsobjectgetclassinfo.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Class Information - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_get_class_information(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectgetname.c b/cpukit/rtems/src/rtemsobjectgetname.c index d784c14061..8757e1eec3 100644 --- a/cpukit/rtems/src/rtemsobjectgetname.c +++ b/cpukit/rtems/src/rtemsobjectgetname.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Obtain Object Name as String - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_get_name(). */ /* diff --git a/cpukit/rtems/src/rtemsobjectidapimaximum.c b/cpukit/rtems/src/rtemsobjectidapimaximum.c index 3cfa124c55..3d624b0b5a 100644 --- a/cpukit/rtems/src/rtemsobjectidapimaximum.c +++ b/cpukit/rtems/src/rtemsobjectidapimaximum.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Highest Valid API Index - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_id_api_maximum() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectidapiminimum.c b/cpukit/rtems/src/rtemsobjectidapiminimum.c index 83c0feb981..f9af3914a6 100644 --- a/cpukit/rtems/src/rtemsobjectidapiminimum.c +++ b/cpukit/rtems/src/rtemsobjectidapiminimum.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Lowest Valid API Index - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_id_api_minimum() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectidgetapi.c b/cpukit/rtems/src/rtemsobjectidgetapi.c index 2842a82615..087402a911 100644 --- a/cpukit/rtems/src/rtemsobjectidgetapi.c +++ b/cpukit/rtems/src/rtemsobjectidgetapi.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClassInfo Object Class Information + * @ingroup RTEMSImplClassicObject * - * @brief Get API Portion of Object Id + * @brief This source file contains the implementation of + * rtems_object_id_get_api() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectidgetclass.c b/cpukit/rtems/src/rtemsobjectidgetclass.c index 9d5a19451c..bc2d11a5ea 100644 --- a/cpukit/rtems/src/rtemsobjectidgetclass.c +++ b/cpukit/rtems/src/rtemsobjectidgetclass.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Class Portion of Object Id - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_id_get_class() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectidgetindex.c b/cpukit/rtems/src/rtemsobjectidgetindex.c index 7578220c38..cdcbd2f609 100644 --- a/cpukit/rtems/src/rtemsobjectidgetindex.c +++ b/cpukit/rtems/src/rtemsobjectidgetindex.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Index Portion of Object Id - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_id_get_index() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectidgetnode.c b/cpukit/rtems/src/rtemsobjectidgetnode.c index b32b9cb5cd..4d8a4288d1 100644 --- a/cpukit/rtems/src/rtemsobjectidgetnode.c +++ b/cpukit/rtems/src/rtemsobjectidgetnode.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Get Node Portion of Object Id - * @ingroup ClassicClassInfo + * @ingroup RTEMSImplClassicObject + * + * @brief This source file contains the implementation of + * rtems_object_id_get_node() as a binding for languages other than C/C++. */ /* diff --git a/cpukit/rtems/src/rtemsobjectsetname.c b/cpukit/rtems/src/rtemsobjectsetname.c index 9e1b3a4039..86cb4dac83 100644 --- a/cpukit/rtems/src/rtemsobjectsetname.c +++ b/cpukit/rtems/src/rtemsobjectsetname.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicClassInfo Object Class Information + * @ingroup RTEMSImplClassicObject * - * @brief Set Name of Object + * @brief This source file contains the implementation of + * rtems_object_set_name(). */ /* diff --git a/cpukit/rtems/src/rtemstimer.c b/cpukit/rtems/src/rtemstimer.c index 545ca1ea05..5cca23b0e5 100644 --- a/cpukit/rtems/src/rtemstimer.c +++ b/cpukit/rtems/src/rtemstimer.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer * - * @brief Classic Timer Information with Zero Objects + * @brief This source file contains a definition of the ::_Timer_Information + * with zero objects. */ /* diff --git a/cpukit/rtems/src/scheduleraddprocessor.c b/cpukit/rtems/src/scheduleraddprocessor.c index 51adeec836..d8e55a1c97 100644 --- a/cpukit/rtems/src/scheduleraddprocessor.c +++ b/cpukit/rtems/src/scheduleraddprocessor.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_add_processor(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/schedulergetmaxprio.c b/cpukit/rtems/src/schedulergetmaxprio.c index 96c65f582b..49633387e0 100644 --- a/cpukit/rtems/src/schedulergetmaxprio.c +++ b/cpukit/rtems/src/schedulergetmaxprio.c @@ -1,6 +1,15 @@ -/* - * SPDX-License-Identifier: BSD-2-Clause +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSImplClassic * + * @brief This source file contains the implementation of + * rtems_scheduler_get_maximum_priority(). + */ + +/* * Copyright (C) 2018 embedded brains GmbH * * Redistribution and use in source and binary forms, with or without diff --git a/cpukit/rtems/src/schedulergetprocessorset.c b/cpukit/rtems/src/schedulergetprocessorset.c index 3aa7df3f2b..6027ab31a2 100644 --- a/cpukit/rtems/src/schedulergetprocessorset.c +++ b/cpukit/rtems/src/schedulergetprocessorset.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_get_processor_set(). + */ + /* * Copyright (c) 2014, 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/schedulerident.c b/cpukit/rtems/src/schedulerident.c index 8f81d0cca3..bc8ada39df 100644 --- a/cpukit/rtems/src/schedulerident.c +++ b/cpukit/rtems/src/schedulerident.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_ident(). + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/scheduleridentbyprocessor.c b/cpukit/rtems/src/scheduleridentbyprocessor.c index 465796cfcb..a03ef7b04e 100644 --- a/cpukit/rtems/src/scheduleridentbyprocessor.c +++ b/cpukit/rtems/src/scheduleridentbyprocessor.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_ident_by_processor(). + */ + /* * Copyright (c) 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/scheduleridentbyprocessorset.c b/cpukit/rtems/src/scheduleridentbyprocessorset.c index 7a14521993..3d48bfba3e 100644 --- a/cpukit/rtems/src/scheduleridentbyprocessorset.c +++ b/cpukit/rtems/src/scheduleridentbyprocessorset.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_ident_by_processor_set(). + */ + /* * Copyright (c) 2017 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/schedulermapfromposix.c b/cpukit/rtems/src/schedulermapfromposix.c index ba29bca2b7..72170582a4 100644 --- a/cpukit/rtems/src/schedulermapfromposix.c +++ b/cpukit/rtems/src/schedulermapfromposix.c @@ -3,9 +3,10 @@ /** * @file * - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassic * - * @brief Implementation of rtems_scheduler_map_priority_from_posix(). + * @brief This source file contains the implementation of + * rtems_scheduler_map_priority_from_posix(). */ /* diff --git a/cpukit/rtems/src/schedulermaptoposix.c b/cpukit/rtems/src/schedulermaptoposix.c index 17bc757a52..38afe87d0e 100644 --- a/cpukit/rtems/src/schedulermaptoposix.c +++ b/cpukit/rtems/src/schedulermaptoposix.c @@ -3,9 +3,10 @@ /** * @file * - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassic * - * @brief Implementation of rtems_scheduler_map_priority_to_posix(). + * @brief This source file contains the implementation of + * rtems_scheduler_map_priority_to_posix(). */ /* diff --git a/cpukit/rtems/src/schedulerremoveprocessor.c b/cpukit/rtems/src/schedulerremoveprocessor.c index 62cfd2576e..79c17bda49 100644 --- a/cpukit/rtems/src/schedulerremoveprocessor.c +++ b/cpukit/rtems/src/schedulerremoveprocessor.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_scheduler_remove_processor(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/sem.c b/cpukit/rtems/src/sem.c index a50cf9c4bd..a248d54a18 100644 --- a/cpukit/rtems/src/sem.c +++ b/cpukit/rtems/src/sem.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicSem + * @ingroup RTEMSImplClassicSemaphore * - * @brief Classic Semaphore Information with Zero Objects + * @brief This source file contains a definition of the + * ::_Semaphore_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/semcreate.c b/cpukit/rtems/src/semcreate.c index b57b635d85..20c2c7192d 100644 --- a/cpukit/rtems/src/semcreate.c +++ b/cpukit/rtems/src/semcreate.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicSem Semaphores + * @ingroup RTEMSImplClassicSemaphore * - * @brief rtems_semaphore_create + * @brief This source file contains the implementation of + * rtems_semaphore_create() and the Semaphore Manager system initialization. */ /* diff --git a/cpukit/rtems/src/semdelete.c b/cpukit/rtems/src/semdelete.c index b4564fbf25..a2a8e00a3f 100644 --- a/cpukit/rtems/src/semdelete.c +++ b/cpukit/rtems/src/semdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Semaphore - * @ingroup ClassicSem + * @ingroup RTEMSImplClassicSemaphore + * + * @brief This source file contains the implementation of + * rtems_semaphore_delete(). */ /* diff --git a/cpukit/rtems/src/semflush.c b/cpukit/rtems/src/semflush.c index a657a71366..0495f9e3fa 100644 --- a/cpukit/rtems/src/semflush.c +++ b/cpukit/rtems/src/semflush.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Semaphore Flush - * @ingroup ClassicSem + * @ingroup RTEMSImplClassicSemaphore + * + * @brief This source file contains the implementation of + * rtems_semaphore_flush(). */ /* diff --git a/cpukit/rtems/src/semident.c b/cpukit/rtems/src/semident.c index 5edfb20180..d3f3446e93 100644 --- a/cpukit/rtems/src/semident.c +++ b/cpukit/rtems/src/semident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicSemaphore * - * @brief rtems_semaphore_ident() Implementation + * @brief This source file contains the implementation of + * rtems_semaphore_ident(). */ /* diff --git a/cpukit/rtems/src/semmp.c b/cpukit/rtems/src/semmp.c index 849bb6e84a..ab1c776e81 100644 --- a/cpukit/rtems/src/semmp.c +++ b/cpukit/rtems/src/semmp.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Semaphore MP Support - * @ingroup ClassicSEM + * @ingroup RTEMSImplClassicSemaphoreMP + * + * @brief This source file contains the implementation to support the Semaphore + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/semobtain.c b/cpukit/rtems/src/semobtain.c index ae1cb864b7..de8aad8903 100644 --- a/cpukit/rtems/src/semobtain.c +++ b/cpukit/rtems/src/semobtain.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Obtain Semaphore - * @ingroup ClassicSem + * @ingroup RTEMSImplClassicSemaphore + * + * @brief This source file contains the implementation of + * rtems_semaphore_obtain(). */ /* diff --git a/cpukit/rtems/src/semrelease.c b/cpukit/rtems/src/semrelease.c index e5b0e4834d..c31f242a98 100644 --- a/cpukit/rtems/src/semrelease.c +++ b/cpukit/rtems/src/semrelease.c @@ -1,12 +1,10 @@ /** * @file * - * @ingroup ClassicSem Semaphores + * @ingroup RTEMSImplClassicSemaphore * - * @brief RTEMS Semaphore Release - * - * This file contains the implementation of the Classic API directive - * rtems_semaphore_release(). + * @brief This source file contains the implementation of + * rtems_semaphore_release(). */ /* diff --git a/cpukit/rtems/src/semsetpriority.c b/cpukit/rtems/src/semsetpriority.c index 933114f96a..adb0320210 100644 --- a/cpukit/rtems/src/semsetpriority.c +++ b/cpukit/rtems/src/semsetpriority.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicSemaphore + * + * @brief This source file contains the implementation of + * rtems_semaphore_set_priority(). + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/signalcatch.c b/cpukit/rtems/src/signalcatch.c index 5ace9642fb..c59e132ad3 100644 --- a/cpukit/rtems/src/signalcatch.c +++ b/cpukit/rtems/src/signalcatch.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief RTEMS Catch Signal - * @ingroup ClassicSignal + * @ingroup RTEMSImplClassicSignal + * + * @brief This source file contains the implementation of + * rtems_signal_catch() and the Signal Manager multiprocessing (MP) support + * system initialization. */ /* diff --git a/cpukit/rtems/src/signalmp.c b/cpukit/rtems/src/signalmp.c index 81b83765b6..b96c8b0a96 100644 --- a/cpukit/rtems/src/signalmp.c +++ b/cpukit/rtems/src/signalmp.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Signal MP Support - * @ingroup ClassicSignalMP + * @ingroup RTEMSImplClassicSignalMP + * + * @brief This source file contains the implementation to support the Signal + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/signalsend.c b/cpukit/rtems/src/signalsend.c index ea649da57f..efc3a9566a 100644 --- a/cpukit/rtems/src/signalsend.c +++ b/cpukit/rtems/src/signalsend.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Send Signal - * @ingroup ClassicSignal + * @ingroup RTEMSImplClassicSignal + * + * @brief This source file contains the implementation of + * rtems_signal_send(). */ /* diff --git a/cpukit/rtems/src/status.c b/cpukit/rtems/src/status.c index a18e32f965..a4aebd2c05 100644 --- a/cpukit/rtems/src/status.c +++ b/cpukit/rtems/src/status.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Status Mapping Arrays - * @ingroup ClassicStatus + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the definition of + * ::_Status_Object_name_errors_to_status. */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/rtems/src/statustext.c b/cpukit/rtems/src/statustext.c index 7d507db885..86c06830b6 100644 --- a/cpukit/rtems/src/statustext.c +++ b/cpukit/rtems/src/statustext.c @@ -1,7 +1,10 @@ /** * @file * - * @ingroup ClassicStatus + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_status_text(). */ /* diff --git a/cpukit/rtems/src/statustoerrno.c b/cpukit/rtems/src/statustoerrno.c index 76a9e2c056..84ba739186 100644 --- a/cpukit/rtems/src/statustoerrno.c +++ b/cpukit/rtems/src/statustoerrno.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief Status Mapping Arrays - * @ingroup ClassicStatus + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_status_code_to_errno(). */ /* COPYRIGHT (c) 1989-2013. diff --git a/cpukit/rtems/src/taskconstruct.c b/cpukit/rtems/src/taskconstruct.c index 84e59552c6..6ff83a0b9c 100644 --- a/cpukit/rtems/src/taskconstruct.c +++ b/cpukit/rtems/src/taskconstruct.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask * - * @brief RTEMS Task Create from Config + * @brief This source file contains the implementation of + * rtems_task_construct() and the Task Manager system initialization. */ /* diff --git a/cpukit/rtems/src/taskconstructuser.c b/cpukit/rtems/src/taskconstructuser.c index bc59aabdd2..347d5cc2ce 100644 --- a/cpukit/rtems/src/taskconstructuser.c +++ b/cpukit/rtems/src/taskconstructuser.c @@ -3,7 +3,7 @@ /** * @file * - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask * * @brief This source file contains the implementation of * _RTEMS_tasks_Construct_user_task(). diff --git a/cpukit/rtems/src/taskcreate.c b/cpukit/rtems/src/taskcreate.c index 917d931424..c065a159c6 100644 --- a/cpukit/rtems/src/taskcreate.c +++ b/cpukit/rtems/src/taskcreate.c @@ -3,9 +3,10 @@ /** * @file * - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask * - * @brief RTEMS Task Create + * @brief This source file contains the implementation of + * rtems_task_create(). */ /* diff --git a/cpukit/rtems/src/taskdelete.c b/cpukit/rtems/src/taskdelete.c index 0122b94b18..852cf3b4c1 100644 --- a/cpukit/rtems/src/taskdelete.c +++ b/cpukit/rtems/src/taskdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Task - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_delete(). */ /* diff --git a/cpukit/rtems/src/taskexit.c b/cpukit/rtems/src/taskexit.c index a1b0d81d37..c08089e956 100644 --- a/cpukit/rtems/src/taskexit.c +++ b/cpukit/rtems/src/taskexit.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_exit(). + */ + /* * Copyright (c) 2018 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/taskgetaffinity.c b/cpukit/rtems/src/taskgetaffinity.c index 9f4b653d4c..d08c2d6835 100644 --- a/cpukit/rtems/src/taskgetaffinity.c +++ b/cpukit/rtems/src/taskgetaffinity.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks Tasks + * @ingroup RTEMSImplClassicTask * - * @brief RTEMS Task Get Affinity + * @brief This source file contains the implementation of + * rtems_task_get_affinity(). */ /* diff --git a/cpukit/rtems/src/taskgetpriority.c b/cpukit/rtems/src/taskgetpriority.c index 6770cdaaa5..8b031aa103 100644 --- a/cpukit/rtems/src/taskgetpriority.c +++ b/cpukit/rtems/src/taskgetpriority.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_get_priority(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/taskgetscheduler.c b/cpukit/rtems/src/taskgetscheduler.c index d2980184b4..4b3e6a28a2 100644 --- a/cpukit/rtems/src/taskgetscheduler.c +++ b/cpukit/rtems/src/taskgetscheduler.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_get_scheduler(). + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/taskident.c b/cpukit/rtems/src/taskident.c index c92a050f29..74a0a53982 100644 --- a/cpukit/rtems/src/taskident.c +++ b/cpukit/rtems/src/taskident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicTask * - * @brief rtems_task_ident() Implementation + * @brief This source file contains the implementation of + * rtems_task_ident(). */ /* diff --git a/cpukit/rtems/src/taskinitdefault.c b/cpukit/rtems/src/taskinitdefault.c index 168723688f..8c4ade4d8a 100644 --- a/cpukit/rtems/src/taskinitdefault.c +++ b/cpukit/rtems/src/taskinitdefault.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains a definition of + * ::_RTEMS_tasks_User_task_table without a task entry. + */ + /* * SPDX-License-Identifier: BSD-2-Clause * diff --git a/cpukit/rtems/src/taskinitusers.c b/cpukit/rtems/src/taskinitusers.c index f21c061670..d426e739b8 100644 --- a/cpukit/rtems/src/taskinitusers.c +++ b/cpukit/rtems/src/taskinitusers.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks Tasks + * @ingroup RTEMSImplClassicTask * - * @brief _RTEMS_tasks_Initialize_user_tasks_body + * @brief This source file contains the implementation of + * _RTEMS_tasks_Initialize_user_task(). */ /* diff --git a/cpukit/rtems/src/taskissuspended.c b/cpukit/rtems/src/taskissuspended.c index db9850ccb1..e8743b3f4e 100644 --- a/cpukit/rtems/src/taskissuspended.c +++ b/cpukit/rtems/src/taskissuspended.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks Tasks + * @ingroup RTEMSImplClassicTask * - * @brief rtems_task_is_suspended + * @brief This source file contains the implementation of + * rtems_task_is_suspended(). */ /* diff --git a/cpukit/rtems/src/taskiterate.c b/cpukit/rtems/src/taskiterate.c index 2d1694d56f..5e80792464 100644 --- a/cpukit/rtems/src/taskiterate.c +++ b/cpukit/rtems/src/taskiterate.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_iterate(). + */ + /* * Copyright (c) 2016 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/taskmode.c b/cpukit/rtems/src/taskmode.c index 2d526ccfa8..cbf8c06a6b 100644 --- a/cpukit/rtems/src/taskmode.c +++ b/cpukit/rtems/src/taskmode.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Task Mode - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_mode(). */ /* diff --git a/cpukit/rtems/src/taskmp.c b/cpukit/rtems/src/taskmp.c index 525c595ae3..b295035bfe 100644 --- a/cpukit/rtems/src/taskmp.c +++ b/cpukit/rtems/src/taskmp.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTaskMP Task MP Support + * @ingroup RTEMSImplClassicTaskMP * - * @brief RTEMS Tasks MP Send Process Packet + * @brief This source file contains the implementation to support the Task + * Manager in multiprocessing (MP) configurations. */ /* diff --git a/cpukit/rtems/src/taskrestart.c b/cpukit/rtems/src/taskrestart.c index c27b876cc9..6a56ff571b 100644 --- a/cpukit/rtems/src/taskrestart.c +++ b/cpukit/rtems/src/taskrestart.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Task Restart - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_restart(). */ /* diff --git a/cpukit/rtems/src/taskresume.c b/cpukit/rtems/src/taskresume.c index 4b4f906615..73d07eb4b8 100644 --- a/cpukit/rtems/src/taskresume.c +++ b/cpukit/rtems/src/taskresume.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Resume Task - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_resume(). */ /* diff --git a/cpukit/rtems/src/tasks.c b/cpukit/rtems/src/tasks.c index c710134f7b..6dde7a307b 100644 --- a/cpukit/rtems/src/tasks.c +++ b/cpukit/rtems/src/tasks.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Task API Extensions - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains a definition of the + * ::_RTEMS_tasks_Information with zero objects. */ /* diff --git a/cpukit/rtems/src/taskself.c b/cpukit/rtems/src/taskself.c index 6d34e702d4..193e691ce5 100644 --- a/cpukit/rtems/src/taskself.c +++ b/cpukit/rtems/src/taskself.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Self Task Id - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_self(). */ /* diff --git a/cpukit/rtems/src/tasksetaffinity.c b/cpukit/rtems/src/tasksetaffinity.c index 826c18dca3..c3cfbf08cb 100644 --- a/cpukit/rtems/src/tasksetaffinity.c +++ b/cpukit/rtems/src/tasksetaffinity.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks Tasks + * @ingroup RTEMSImplClassicTask * - * @brief RTEMS Task Set Affinity + * @brief This source file contains the implementation of + * rtems_task_set_affinity(). */ /* diff --git a/cpukit/rtems/src/tasksetpriority.c b/cpukit/rtems/src/tasksetpriority.c index 1d46d4fb60..50d1bc156c 100644 --- a/cpukit/rtems/src/tasksetpriority.c +++ b/cpukit/rtems/src/tasksetpriority.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Set Task Priority - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_set_priority(). */ /* diff --git a/cpukit/rtems/src/tasksetscheduler.c b/cpukit/rtems/src/tasksetscheduler.c index 2d714b176c..da97e89b5c 100644 --- a/cpukit/rtems/src/tasksetscheduler.c +++ b/cpukit/rtems/src/tasksetscheduler.c @@ -1,3 +1,12 @@ +/** + * @file + * + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_set_scheduler(). + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/taskstart.c b/cpukit/rtems/src/taskstart.c index 247756fcb1..da29240961 100644 --- a/cpukit/rtems/src/taskstart.c +++ b/cpukit/rtems/src/taskstart.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTasks Tasks + * @ingroup RTEMSImplClassicTask * - * @brief RTEMS Start Task + * @brief This source file contains the implementation of + * rtems_task_start(). */ /* diff --git a/cpukit/rtems/src/tasksuspend.c b/cpukit/rtems/src/tasksuspend.c index 5f59922d7b..d2d9ffccc2 100644 --- a/cpukit/rtems/src/tasksuspend.c +++ b/cpukit/rtems/src/tasksuspend.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Suspend Task - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_suspend(). */ /* diff --git a/cpukit/rtems/src/taskwakeafter.c b/cpukit/rtems/src/taskwakeafter.c index ef50f752ee..96fa0dac5a 100644 --- a/cpukit/rtems/src/taskwakeafter.c +++ b/cpukit/rtems/src/taskwakeafter.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Task Wake After - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_wake_after(). */ /* diff --git a/cpukit/rtems/src/taskwakewhen.c b/cpukit/rtems/src/taskwakewhen.c index 39467754ce..5f6a5795fc 100644 --- a/cpukit/rtems/src/taskwakewhen.c +++ b/cpukit/rtems/src/taskwakewhen.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Task Wake When - * @ingroup ClassicTasks + * @ingroup RTEMSImplClassicTask + * + * @brief This source file contains the implementation of + * rtems_task_wake_when(). */ /* diff --git a/cpukit/rtems/src/timercancel.c b/cpukit/rtems/src/timercancel.c index 71f2122319..a276811c0b 100644 --- a/cpukit/rtems/src/timercancel.c +++ b/cpukit/rtems/src/timercancel.c @@ -1,7 +1,13 @@ -/* - * Timer Manager - rtems_timer_cancel directive +/** + * @file * + * @ingroup RTEMSImplClassicTimer * + * @brief This source file contains the implementation of + * rtems_timer_cancel(). + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/timercreate.c b/cpukit/rtems/src/timercreate.c index cadcecb057..ce143f59f6 100644 --- a/cpukit/rtems/src/timercreate.c +++ b/cpukit/rtems/src/timercreate.c @@ -1,8 +1,12 @@ /** - * @file + * @file * - * @brief RTEMS Create Timer - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the definition of ::_Timer_server and the + * implementation of _Timer_Routine_adaptor(), _Timer_Fire(), + * _Timer_Fire_after(), _Timer_Fire_when(), _Timer_Cancel(), and the Timer + * Manager system initialization. */ /* diff --git a/cpukit/rtems/src/timerdelete.c b/cpukit/rtems/src/timerdelete.c index d77c0b2bce..eb86f858e6 100644 --- a/cpukit/rtems/src/timerdelete.c +++ b/cpukit/rtems/src/timerdelete.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Delete Timer - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the implementation of + * rtems_timer_delete(). */ /* diff --git a/cpukit/rtems/src/timerfireafter.c b/cpukit/rtems/src/timerfireafter.c index 61a79053f1..f98b5cd498 100644 --- a/cpukit/rtems/src/timerfireafter.c +++ b/cpukit/rtems/src/timerfireafter.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Timer Fire After - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the implementation of + * rtems_timer_fire_after(). */ /* diff --git a/cpukit/rtems/src/timerfirewhen.c b/cpukit/rtems/src/timerfirewhen.c index b1610a0b49..33b2e4480e 100644 --- a/cpukit/rtems/src/timerfirewhen.c +++ b/cpukit/rtems/src/timerfirewhen.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Timer Fire When - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the implementation of + * rtems_timer_fire_when(). */ /* diff --git a/cpukit/rtems/src/timergetinfo.c b/cpukit/rtems/src/timergetinfo.c index 081db61409..73bdfcab33 100644 --- a/cpukit/rtems/src/timergetinfo.c +++ b/cpukit/rtems/src/timergetinfo.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Get Timer Information - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the implementation of + * rtems_timer_get_information(). */ /* diff --git a/cpukit/rtems/src/timerident.c b/cpukit/rtems/src/timerident.c index 273af1564c..f256b3558d 100644 --- a/cpukit/rtems/src/timerident.c +++ b/cpukit/rtems/src/timerident.c @@ -5,7 +5,8 @@ * * @ingroup RTEMSImplClassicTimer * - * @brief rtems_timer_ident() Implementation + * @brief This source file contains the implementation of + * rtems_timer_ident(). */ /* diff --git a/cpukit/rtems/src/timerreset.c b/cpukit/rtems/src/timerreset.c index 683264d839..6811568316 100644 --- a/cpukit/rtems/src/timerreset.c +++ b/cpukit/rtems/src/timerreset.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTimer Timers + * @ingroup RTEMSImplClassicTimer * - * @brief RTEMS Timer Reset + * @brief This source file contains the implementation of + * rtems_timer_reset(). */ /* diff --git a/cpukit/rtems/src/timerserver.c b/cpukit/rtems/src/timerserver.c index 0ac1e89268..3c994933cd 100644 --- a/cpukit/rtems/src/timerserver.c +++ b/cpukit/rtems/src/timerserver.c @@ -1,15 +1,10 @@ /** - * @file + * @file * - * Timer Manager - rtems_timer_initiate_server directive along with - * the Timer Server Body and support routines + * @ingroup RTEMSImplClassicTimer * - * @note Data specific to the Timer Server is declared in this - * file as the Timer Server so it does not have to be in the - * minimum footprint. It is only really required when - * task-based timers are used. Since task-based timers can - * not be started until the server is initiated, this structure - * does not have to be initialized until then. + * @brief This source file contains the implementation of + * rtems_timer_initiate_server(). */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/rtems/src/timerserverfireafter.c b/cpukit/rtems/src/timerserverfireafter.c index a4a7e97727..4faf4ee910 100644 --- a/cpukit/rtems/src/timerserverfireafter.c +++ b/cpukit/rtems/src/timerserverfireafter.c @@ -1,8 +1,10 @@ /** - * @file + * @file * - * @brief RTEMS Timer Server Fire After - * @ingroup ClassicTimer + * @ingroup RTEMSImplClassicTimer + * + * @brief This source file contains the implementation of + * rtems_timer_server_fire_after(). */ /* diff --git a/cpukit/rtems/src/timerserverfirewhen.c b/cpukit/rtems/src/timerserverfirewhen.c index ca3961e1e5..807fff98d7 100644 --- a/cpukit/rtems/src/timerserverfirewhen.c +++ b/cpukit/rtems/src/timerserverfirewhen.c @@ -1,9 +1,10 @@ /** * @file * - * @ingroup ClassicTimer Timers + * @ingroup RTEMSImplClassicTimer * - * @brief RTEMS Timer Server Fire When Directive + * @brief This source file contains the implementation of + * rtems_timer_server_fire_when(). */ /* diff --git a/cpukit/rtems/src/workspace.c b/cpukit/rtems/src/workspace.c index a6c5c7599b..39e47033f0 100644 --- a/cpukit/rtems/src/workspace.c +++ b/cpukit/rtems/src/workspace.c @@ -1,8 +1,11 @@ /** - * @file + * @file * - * @brief RTEMS Workspace Support - * @ingroup ClassicRTEMSWorkspace + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_workspace_get_information(), rtems_workspace_allocate(), and + * rtems_workspace_free(). */ /* diff --git a/cpukit/rtems/src/workspacegreedy.c b/cpukit/rtems/src/workspacegreedy.c index 7e70761069..09204c2833 100644 --- a/cpukit/rtems/src/workspacegreedy.c +++ b/cpukit/rtems/src/workspacegreedy.c @@ -1,8 +1,12 @@ /** - * @file + * @file * - * @brief Greedy Allocate that Empties the Workspace and Free - * @ingroup ClassicRTEMS + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_workspace_greedy_allocate(), + * rtems_workspace_greedy_allocate_all_except_largest(), and + * rtems_workspace_greedy_free(). */ /* |