2011-06-17 Joel Sherrill <joel.sherrill@oarcorp.com>

* rtems/include/rtems/rtems/types.h,
	score/include/rtems/score/address.h,
	score/include/rtems/score/apiext.h,
	score/include/rtems/score/bitfield.h,
	score/include/rtems/score/context.h,
	score/include/rtems/score/corebarrier.h,
	score/include/rtems/score/coremsg.h,
	score/include/rtems/score/coremutex.h,
	score/include/rtems/score/corerwlock.h,
	score/include/rtems/score/coresem.h,
	score/include/rtems/score/corespinlock.h,
	score/include/rtems/score/interr.h, score/include/rtems/score/isr.h,
	score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h,
	score/include/rtems/score/objectmp.h,
	score/include/rtems/score/percpu.h,
	score/include/rtems/score/priority.h,
	score/include/rtems/score/rbtree.h,
	score/include/rtems/score/scheduler.h,
	score/include/rtems/score/smp.h, score/include/rtems/score/smplock.h,
	score/include/rtems/score/stack.h,
	score/include/rtems/score/states.h,
	score/include/rtems/score/thread.h,
	score/include/rtems/score/threadq.h,
	score/include/rtems/score/threadsync.h,
	score/include/rtems/score/timespec.h,
	score/include/rtems/score/timestamp.h,
	score/include/rtems/score/timestamp64.h,
	score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h,
	score/include/rtems/score/watchdog.h,
	score/include/rtems/score/wkspace.h: Mark Score files as in Score
	Group to improve Doxygen output.
This commit is contained in:
Joel Sherrill
2011-06-17 15:40:09 +00:00
parent 4b72da419b
commit d8cd045c7c
35 changed files with 106 additions and 2 deletions

View File

@@ -1,3 +1,37 @@
2011-06-17 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems/rtems/types.h,
score/include/rtems/score/address.h,
score/include/rtems/score/apiext.h,
score/include/rtems/score/bitfield.h,
score/include/rtems/score/context.h,
score/include/rtems/score/corebarrier.h,
score/include/rtems/score/coremsg.h,
score/include/rtems/score/coremutex.h,
score/include/rtems/score/corerwlock.h,
score/include/rtems/score/coresem.h,
score/include/rtems/score/corespinlock.h,
score/include/rtems/score/interr.h, score/include/rtems/score/isr.h,
score/include/rtems/score/mpci.h, score/include/rtems/score/mppkt.h,
score/include/rtems/score/objectmp.h,
score/include/rtems/score/percpu.h,
score/include/rtems/score/priority.h,
score/include/rtems/score/rbtree.h,
score/include/rtems/score/scheduler.h,
score/include/rtems/score/smp.h, score/include/rtems/score/smplock.h,
score/include/rtems/score/stack.h,
score/include/rtems/score/states.h,
score/include/rtems/score/thread.h,
score/include/rtems/score/threadq.h,
score/include/rtems/score/threadsync.h,
score/include/rtems/score/timespec.h,
score/include/rtems/score/timestamp.h,
score/include/rtems/score/timestamp64.h,
score/include/rtems/score/tod.h, score/include/rtems/score/tqdata.h,
score/include/rtems/score/watchdog.h,
score/include/rtems/score/wkspace.h: Mark Score files as in Score
Group to improve Doxygen output.
2011-06-17 Joel Sherrill <joel.sherrill@oarcorp.com>
* libcsupport/include/rtems/malloc.h, libmisc/stackchk/stackchk.h,

View File

@@ -125,7 +125,7 @@ typedef Watchdog_Interval rtems_interval;
/**
* @brief Represents the CPU usage per thread.
*
* When using nano seconds granularity timing, RTEMS may internally use a
* When using nanoseconds granularity timing, RTEMS may internally use a
* variety of representations.
*/
#ifndef __RTEMS_USE_TICKS_FOR_STATISTICS__

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreAddress Address Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which abstracts address
* manipulation in a portable manner.
*/

View File

@@ -21,6 +21,8 @@
/**
* @defgroup ScoreAPIExtension API Extension Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides mechanisms for the
* SuperCore to perform API specific actions without there beingg
* "up-references" from the SuperCore to APIs. If these referencesg

View File

@@ -21,6 +21,8 @@
/**
* @defgroup ScoreBitfield Bitfield Handler
*
* @ingroup Score
*
* This handler encapsulates functionality that is used to manipulate the
* priority bitfields used to lookup which priority has the highest
* priority ready to execute thread.

View File

@@ -21,6 +21,8 @@
/**
* @defgroup ScoreContext Context Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which abstracts thread context
* management in a portable manner.
*

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreBarrier Barrier Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Barrier services used in all of the APIs supported by RTEMS.
*/

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreMessageQueue Message Queue Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Message Queue services used in all of the APIs supported by RTEMS.
*/

View File

@@ -25,6 +25,8 @@
/**
* @defgroup ScoreMutex Mutex Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Mutex services used in all of the APIs supported by RTEMS.
*/

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreRWLock RWLock Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* RWLock services used in all of the APIs supported by RTEMS.
*/

View File

@@ -24,6 +24,8 @@
/**
* @defgroup ScoreSemaphore Semaphore Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Semaphore services used in all of the APIs supported by RTEMS.
*/

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreSpinlock Spinlock Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Spinlock services used in all of the APIs supported by RTEMS.
*/

View File

@@ -27,6 +27,8 @@
/**
* @defgroup ScoreIntErr Internal Error Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* Semaphore services used in all of the APIs supported by RTEMS.
*/

View File

@@ -26,6 +26,8 @@
/**
* @defgroup ScoreISR ISR Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which provides the foundation
* ISR services used in all of the APIs supported by RTEMS.
*

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreMPCI MPCI Handler
*
* @ingroup Score
*
* The MPCI Handler encapsulates functionality which is related to the
* generation, receipt, and processing of remote operations in a
* multiprocessor system. This handler contains the message passing

View File

@@ -25,6 +25,8 @@
/**
* @defgroup ScoreMPPacket MP Packet Handler
*
* @ingroup Score
*
* This handler encapsulates the primary definition of MPCI packets. This
* handler defines the part of the packet that is common to all remote
* operations.

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreObjectMP Object Handler Multiprocessing Support
*
* @ingroup Score
*
* This handler encapsulates functionality which is used to manage
* objects which have been declared to be globally visible. This handler
* knows objects from all of the nodes in the system.

View File

@@ -39,6 +39,8 @@
/**
* @defgroup PerCPU RTEMS Per CPU Information
*
* @ingroup Score
*
* This defines the per CPU state information required by RTEMS
* and the BSP. In an SMP configuration, there will be multiple
* instances of this data structure -- one per CPU -- and the

View File

@@ -23,6 +23,8 @@
/**
* @defgroup ScorePriority Priority Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which is used to manage
* thread priorities. At the SuperCore level 256 priority levels
* are supported with lower numbers representing logically more important

View File

@@ -21,6 +21,8 @@
/**
* @defgroup ScoreRBTree Red-Black Tree Handler
*
* @ingroup Score
*
* The Red-Black Tree Handler is used to manage sets of entities. This handler
* provides two data structures. The rbtree Node data structure is included
* as the first part of every data structure that will be placed on

View File

@@ -31,6 +31,8 @@ extern "C" {
/**
* @defgroup ScoreScheduler Scheduler Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to managing sets of threads
* that are ready for execution.
*/

View File

@@ -25,6 +25,8 @@
/**
* @defgroup SuperCore SMP Support
*
* @ingroup Score
*
* This defines the interface of the SuperCore support
* code for SMP support.
*/

View File

@@ -24,6 +24,8 @@
/**
* @defgroup RTEMS Lock Interface
*
* @ingroup Score
*
*/
/**@{*/

View File

@@ -23,6 +23,8 @@
/**
* @defgroup ScoreStack Stack Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which is used in the management
* of thread stacks.
*/

View File

@@ -21,6 +21,8 @@
/**
* @defgroup ScoreStates Thread States Handler
*
* @ingroup Score
*
* This handler encapsulates functionality which relates to the management of
* the state bitmap associated with each thread.
*/

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreThread Thread Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to the management of
* threads. This includes the creation, deletion, and scheduling of threads.
*

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreThreadQ Thread Queue Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to managing sets of threads
* blocked waiting for resources.
*/

View File

@@ -23,6 +23,8 @@
/**
* @defgroup ScoreThreadSync Thread Blocking Operation Synchronization Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to the management of
* synchronization critical sections during blocking operations.
*/

View File

@@ -21,6 +21,8 @@
/**
* @defgroup Timespec Helpers
*
* @ingroup Score
*
* This handler encapsulates functionality related to manipulating
* POSIX struct timespecs.
*/

View File

@@ -21,6 +21,8 @@
/**
* @defgroup SuperCore Timestamp
*
* @ingroup Score
*
* This handler encapsulates functionality related to manipulating
* SuperCore Timestamps. SuperCore Timestamps may be used to
* represent time of day, uptime, or intervals.

View File

@@ -22,6 +22,8 @@
/**
* @defgroup SuperCore Timestamp64
*
* @ingroup Score
*
* This handler encapsulates functionality related to manipulating
* the 64 bit integer implementation of SuperCore Timestamps.
*/

View File

@@ -27,7 +27,11 @@
extern "C" {
#endif
/** @defgroup ScoreTODConstants TOD Constants
/**
* @defgroup ScoreTODConstants TOD Constants
*
* @ingroup Score
*
* The following constants are related to the time of day and are
* independent of RTEMS.
*/
@@ -114,6 +118,8 @@ extern "C" {
/**
* @defgroup ScoreTOD Time Of Day (TOD) Handler
*
* @ingroup Score
*
* This handler encapsulates functionality used to manage time of day.
*/
/**@{*/

View File

@@ -22,6 +22,8 @@
/**
* @defgroup ScoreThreadQData Thread Queue Handler Data Definition
*
* @ingroup Score
*
* This handler defines the data shared between the thread and thread
* queue handlers. Having this handler define these data structure
* avoids potentially circular references.

View File

@@ -23,6 +23,8 @@
/**
* @defgroup ScoreWatchdog Watchdog Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to the scheduling of
* watchdog functions to be called at specific times in the future.
*

View File

@@ -23,6 +23,8 @@
/**
* @defgroup ScoreWorkspace Workspace Handler
*
* @ingroup Score
*
* This handler encapsulates functionality related to the management of
* the RTEMS Executive Workspace.
*/