summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-04-18 15:02:20 +0000
commit067a96ad0c3b0818d71d9aaadaee4b520d940de1 (patch)
treed04eed432a0534ebfb0830d6f7e49ce78ff098a4 /cpukit/rtems/inline
parent2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-067a96ad0c3b0818d71d9aaadaee4b520d940de1.tar.bz2
2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>
* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/options.h, rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h, rtems/include/rtems/rtems/ratemon.h, rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/regionmp.h, rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h, rtems/include/rtems/rtems/signalmp.h, rtems/include/rtems/rtems/status.h, rtems/include/rtems/rtems/support.h, rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl, rtems/inline/rtems/rtems/attr.inl, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/dpmem.inl, rtems/inline/rtems/rtems/event.inl, rtems/inline/rtems/rtems/eventset.inl, rtems/inline/rtems/rtems/message.inl, rtems/inline/rtems/rtems/modes.inl, rtems/inline/rtems/rtems/options.inl, rtems/inline/rtems/rtems/part.inl, rtems/inline/rtems/rtems/ratemon.inl, rtems/inline/rtems/rtems/region.inl, rtems/inline/rtems/rtems/sem.inl, rtems/inline/rtems/rtems/status.inl, rtems/inline/rtems/rtems/support.inl, rtems/inline/rtems/rtems/tasks.inl, rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API header files to Doxygen. * rtems/Doxyfile: New file.
Diffstat (limited to 'cpukit/rtems/inline')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/asr.inl55
-rw-r--r--cpukit/rtems/inline/rtems/rtems/attr.inl111
-rw-r--r--cpukit/rtems/inline/rtems/rtems/barrier.inl16
-rw-r--r--cpukit/rtems/inline/rtems/rtems/dpmem.inl47
-rw-r--r--cpukit/rtems/inline/rtems/rtems/event.inl16
-rw-r--r--cpukit/rtems/inline/rtems/rtems/eventset.inl46
-rw-r--r--cpukit/rtems/inline/rtems/rtems/message.inl40
-rw-r--r--cpukit/rtems/inline/rtems/rtems/modes.inl72
-rw-r--r--cpukit/rtems/inline/rtems/rtems/options.inl32
-rw-r--r--cpukit/rtems/inline/rtems/rtems/part.inl88
-rw-r--r--cpukit/rtems/inline/rtems/rtems/ratemon.inl72
-rw-r--r--cpukit/rtems/inline/rtems/rtems/region.inl62
-rw-r--r--cpukit/rtems/inline/rtems/rtems/sem.inl48
-rw-r--r--cpukit/rtems/inline/rtems/rtems/status.inl32
-rw-r--r--cpukit/rtems/inline/rtems/rtems/support.inl28
-rw-r--r--cpukit/rtems/inline/rtems/rtems/tasks.inl48
-rw-r--r--cpukit/rtems/inline/rtems/rtems/timer.inl72
17 files changed, 336 insertions, 549 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/asr.inl b/cpukit/rtems/inline/rtems/rtems/asr.inl
index bd3b37e060..43bbbea5b5 100644
--- a/cpukit/rtems/inline/rtems/rtems/asr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/asr.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/asr.inl
- */
-
-/*
+ *
* This include file contains the implemenation of all routines
* associated with the asynchronous signal handler which are inlined.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -21,15 +20,16 @@
#include <rtems/score/isr.h>
-/*PAGE
- *
- * _ASR_Initialize
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicASR
+ * @{
+ */
+
+/**
+ * @brief ASR_Initialize
*
* This routine initializes the given RTEMS_ASR information record.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Initialize (
ASR_Information *information
)
@@ -42,17 +42,13 @@ RTEMS_INLINE_ROUTINE void _ASR_Initialize (
information->nest_level = 0;
}
-/*PAGE
- *
- * _ASR_Swap_signals
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Swap_signals
*
* This routine atomically swaps the pending and posted signal
* sets. This is done when the thread alters its mode in such a
* way that the RTEMS_ASR disable/enable flag changes.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Swap_signals (
ASR_Information *information
)
@@ -67,16 +63,12 @@ RTEMS_INLINE_ROUTINE void _ASR_Swap_signals (
_ISR_Enable( _level );
}
-/*PAGE
- *
- * _ASR_Is_null_handler
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Is_null_handler
*
* This function returns TRUE if the given asr_handler is NULL and
* FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _ASR_Is_null_handler (
rtems_asr_entry asr_handler
)
@@ -84,16 +76,12 @@ RTEMS_INLINE_ROUTINE boolean _ASR_Is_null_handler (
return asr_handler == NULL;
}
-/*PAGE
- *
- * _ASR_Are_signals_pending
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Are_signals_pending
*
* This function returns TRUE if there are signals pending in the
* given RTEMS_ASR information record and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _ASR_Are_signals_pending (
ASR_Information *information
)
@@ -101,18 +89,14 @@ RTEMS_INLINE_ROUTINE boolean _ASR_Are_signals_pending (
return information->signals_posted != 0;
}
-/*PAGE
- *
- * _ASR_Post_signals
- *
- * DESCRIPTION:
+/**
+ * @brief ASR_Post_signals
*
* This routine posts the given signals into the signal_set
* passed in. The result is returned to the user in signal_set.
*
* NOTE: This must be implemented as a macro.
*/
-
RTEMS_INLINE_ROUTINE void _ASR_Post_signals(
rtems_signal_set signals,
rtems_signal_set *signal_set
@@ -125,6 +109,7 @@ RTEMS_INLINE_ROUTINE void _ASR_Post_signals(
_ISR_Enable( _level );
}
+/**@}*/
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/attr.inl b/cpukit/rtems/inline/rtems/rtems/attr.inl
index 54dd93d729..9e8012728a 100644
--- a/cpukit/rtems/inline/rtems/rtems/attr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/attr.inl
@@ -1,11 +1,11 @@
/**
* @file rtems/rtems/attr.inl
+ *
+ * This include file contains all of the inlined routines associated
+ * with attributes.
*/
/*
- * This include file contains all of the inlined routines associated
- * with attributes.
- *
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,16 +19,17 @@
#ifndef _RTEMS_RTEMS_ATTR_INL
#define _RTEMS_RTEMS_ATTR_INL
-/*PAGE
- *
- * _Attributes_Set
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicAttributes
+ * @{
+ */
+
+/**
+ * @brief Attributes_Set
*
* This function sets the requested new_attributes in the attribute_set
* passed in. The result is returned to the user.
*/
-
RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Set (
rtems_attribute new_attributes,
rtems_attribute attribute_set
@@ -37,16 +38,12 @@ RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Set (
return attribute_set | new_attributes;
}
-/*PAGE
- *
- * _Attributes_Clear
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Clear
*
* This function clears the requested new_attributes in the attribute_set
* passed in. The result is returned to the user.
*/
-
RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Clear (
rtems_attribute attribute_set,
rtems_attribute mask
@@ -55,16 +52,12 @@ RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Clear (
return attribute_set & ~mask;
}
-/*PAGE
- *
- * _Attributes_Is_floating_point
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_floating_point
*
* This function returns TRUE if the floating point attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_floating_point(
rtems_attribute attribute_set
)
@@ -72,17 +65,13 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_floating_point(
return ( attribute_set & RTEMS_FLOATING_POINT );
}
-/*PAGE
- *
- * _Attributes_Is_global
- *
- * DESCRIPTION:
+#if defined(RTEMS_MULTIPROCESSING)
+/**
+ * @brief Attributes_Is_global
*
* This function returns TRUE if the global object attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
-#if defined(RTEMS_MULTIPROCESSING)
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_global(
rtems_attribute attribute_set
)
@@ -91,16 +80,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_global(
}
#endif
-/*PAGE
- *
- * _Attributes_Is_priority
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_priority
*
* This function returns TRUE if the priority attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_priority(
rtems_attribute attribute_set
)
@@ -108,16 +93,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_priority(
return ( attribute_set & RTEMS_PRIORITY );
}
-/*PAGE
- *
- * _Attributes_Is_binary_semaphore
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_binary_semaphore
*
* This function returns TRUE if the binary semaphore attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_binary_semaphore(
rtems_attribute attribute_set
)
@@ -125,16 +106,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_binary_semaphore(
return ((attribute_set & RTEMS_SEMAPHORE_CLASS) == RTEMS_BINARY_SEMAPHORE);
}
-/*PAGE
- *
- * _Attributes_Is_simple_binary_semaphore
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_simple_binary_semaphore
*
* This function returns TRUE if the simple binary semaphore attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_simple_binary_semaphore(
rtems_attribute attribute_set
)
@@ -143,16 +120,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_simple_binary_semaphore(
((attribute_set & RTEMS_SEMAPHORE_CLASS) == RTEMS_SIMPLE_BINARY_SEMAPHORE);
}
-/*PAGE
- *
- * _Attributes_Is_counting_semaphore
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_counting_semaphore
*
* This function returns TRUE if the counting semaphore attribute is
* enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_counting_semaphore(
rtems_attribute attribute_set
)
@@ -160,16 +133,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_counting_semaphore(
return ((attribute_set & RTEMS_SEMAPHORE_CLASS) == RTEMS_COUNTING_SEMAPHORE);
}
-/*PAGE
- *
- * _Attributes_Is_inherit_priority
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_inherit_priority
*
* This function returns TRUE if the priority inheritance attribute
* is enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_inherit_priority(
rtems_attribute attribute_set
)
@@ -177,16 +146,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_inherit_priority(
return ( attribute_set & RTEMS_INHERIT_PRIORITY );
}
-/*PAGE
- *
- * _Attributes_Is_priority_ceiling
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_priority_ceiling
*
* This function returns TRUE if the priority ceiling attribute
* is enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_priority_ceiling(
rtems_attribute attribute_set
)
@@ -194,16 +159,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_priority_ceiling(
return ( attribute_set & RTEMS_PRIORITY_CEILING );
}
-/*PAGE
- *
- * _Attributes_Is_barrier_automatic
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_barrier_automatic
*
* This function returns TRUE if the barrier automatic release
* attribute is enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_barrier_automatic(
rtems_attribute attribute_set
)
@@ -211,16 +172,12 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_barrier_automatic(
return ( attribute_set & RTEMS_BARRIER_AUTOMATIC_RELEASE );
}
-/*PAGE
- *
- * _Attributes_Is_system_task
- *
- * DESCRIPTION:
+/**
+ * @brief Attributes_Is_system_task
*
* This function returns TRUE if the system task attribute
* is enabled in the attribute_set and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Attributes_Is_system_task(
rtems_attribute attribute_set
)
@@ -228,5 +185,7 @@ RTEMS_INLINE_ROUTINE boolean _Attributes_Is_system_task(
return ( attribute_set & RTEMS_SYSTEM_TASK );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/barrier.inl b/cpukit/rtems/inline/rtems/rtems/barrier.inl
index e296b88e72..e690da2469 100644
--- a/cpukit/rtems/inline/rtems/rtems/barrier.inl
+++ b/cpukit/rtems/inline/rtems/rtems/barrier.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/barrier.inl
- */
-
-/*
+ *
* This file contains the static inlin implementation of the inlined
* routines from the Barrier Manager.
- *
- * COPYRIGHT (c) 1989-2006.
+ */
+
+/* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -20,6 +19,11 @@
#define _RTEMS_RTEMS_BARRIER_INL
/**
+ * @addtogroup ClassicBarrier
+ * @{
+ */
+
+/**
* @brief _Barrier_Allocate
*
* This function allocates a barrier control block from
@@ -75,5 +79,7 @@ RTEMS_INLINE_ROUTINE boolean _Barrier_Is_null (
return ( the_barrier == NULL );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/dpmem.inl b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
index f80d2ebaf5..2c3bee2741 100644
--- a/cpukit/rtems/inline/rtems/rtems/dpmem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/dpmem.inl
- */
-
-/*
+ *
* This include file contains the inline routine used in conjunction
* with the Dual Ported Memory Manager
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,17 +18,17 @@
#ifndef _RTEMS_RTEMS_DPMEM_INL
#define _RTEMS_RTEMS_DPMEM_INL
+/**
+ * @addtogroup ClassicDPMEM
+ * @{
+ */
-/*PAGE
- *
- * _Dual_ported_memory_Allocate
- *
- * DESCRIPTION:
+/**
+ * @brief Dual_ported_memory_Allocate
*
* This routine allocates a port control block from the inactive chain
* of free port control blocks.
*/
-
RTEMS_INLINE_ROUTINE Dual_ported_memory_Control
*_Dual_ported_memory_Allocate ( void )
{
@@ -37,16 +36,12 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control
_Objects_Allocate( &_Dual_ported_memory_Information );
}
-/*PAGE
- *
- * _Dual_ported_memory_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Dual_ported_memory_Free
*
* This routine frees a port control block to the inactive chain
* of free port control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
Dual_ported_memory_Control *the_port
)
@@ -54,11 +49,8 @@ RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
_Objects_Free( &_Dual_ported_memory_Information, &the_port->Object );
}
-/*PAGE
- *
- * _Dual_ported_memory_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Dual_ported_memory_Get
*
* This function maps port IDs to port control blocks. If ID
* corresponds to a local port, then it returns the_port control
@@ -67,7 +59,6 @@ RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
* local port, location is set to OBJECTS_ERROR and the_port is
* undefined.
*/
-
RTEMS_INLINE_ROUTINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
Objects_Id id,
Objects_Locations *location
@@ -77,15 +68,11 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
_Objects_Get( &_Dual_ported_memory_Information, id, location );
}
-/*PAGE
- *
- * _Dual_ported_memory_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Dual_ported_memory_Is_null
*
* This function returns TRUE if the_port is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Dual_ported_memory_Is_null(
Dual_ported_memory_Control *the_port
)
@@ -93,5 +80,7 @@ RTEMS_INLINE_ROUTINE boolean _Dual_ported_memory_Is_null(
return ( the_port == NULL );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/event.inl b/cpukit/rtems/inline/rtems/rtems/event.inl
index 0ad4bc0be3..02155e3268 100644
--- a/cpukit/rtems/inline/rtems/rtems/event.inl
+++ b/cpukit/rtems/inline/rtems/rtems/event.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/event.inl
- */
-
-/*
+ *
* This include file contains the static inline implementation of
* macros for the Event Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,5 +18,12 @@
#ifndef _RTEMS_RTEMS_EVENT_INL
#define _RTEMS_RTEMS_EVENT_INL
+/**
+ * @addtogroup ClassicEvent
+ * @{
+ */
+
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/eventset.inl b/cpukit/rtems/inline/rtems/rtems/eventset.inl
index dff78bdce0..917df94f89 100644
--- a/cpukit/rtems/inline/rtems/rtems/eventset.inl
+++ b/cpukit/rtems/inline/rtems/rtems/eventset.inl
@@ -1,11 +1,10 @@
/**
* @file rtems/rtems/eventset.inl
+ *
+ * This include file contains the information pertaining to event sets.
*/
-/*
- * This include file contains the information pertaining to event sets.
- *
- * COPYRIGHT (c) 1989-2008.
+/* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -18,16 +17,17 @@
#ifndef _RTEMS_RTEMS_EVENTSET_INL
#define _RTEMS_RTEMS_EVENTSET_INL
-/*PAGE
- *
- * _Event_sets_Is_empty
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicEventSet
+ * @{
+ */
+
+/**
+ * @brief Event_sets_Is_empty
*
* This function returns TRUE if on events are posted in the event_set,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Event_sets_Is_empty(
rtems_event_set the_event_set
)
@@ -35,16 +35,12 @@ RTEMS_INLINE_ROUTINE boolean _Event_sets_Is_empty(
return ( the_event_set == 0 );
}
-/*PAGE
- *
- * _Event_sets_Post
- *
- * DESCRIPTION:
+/**
+ * @brief Event_sets_Post
*
* This routine posts the given new_events into the event_set
* passed in. The result is returned to the user in event_set.
*/
-
RTEMS_INLINE_ROUTINE void _Event_sets_Post(
rtems_event_set the_new_events,
rtems_event_set *the_event_set
@@ -57,16 +53,12 @@ RTEMS_INLINE_ROUTINE void _Event_sets_Post(
_ISR_Enable( level );
}
-/*PAGE
- *
- * _Event_sets_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Event_sets_Get
*
* This function returns the events in event_condition which are
* set in event_set.
*/
-
RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Get(
rtems_event_set the_event_set,
rtems_event_set the_event_condition
@@ -75,16 +67,12 @@ RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Get(
return ( the_event_set & the_event_condition );
}
-/*PAGE
- *
- * _Event_sets_Clear
- *
- * DESCRIPTION:
+/**
+ * @brief Event_sets_Clear
*
* This function removes the events in mask from the event_set
* passed in. The result is returned to the user in event_set.
*/
-
RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Clear(
rtems_event_set the_event_set,
rtems_event_set the_mask
@@ -93,5 +81,7 @@ RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Clear(
return ( the_event_set & ~(the_mask) );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/message.inl b/cpukit/rtems/inline/rtems/rtems/message.inl
index 06ccc32e1e..98665c5dac 100644
--- a/cpukit/rtems/inline/rtems/rtems/message.inl
+++ b/cpukit/rtems/inline/rtems/rtems/message.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/message.inl
- */
-
-/*
+ *
* This include file contains the static inline implementation of all
* inlined routines in the Message Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -21,16 +20,17 @@
#include <rtems/score/wkspace.h>
-/*PAGE
- *
- * _Message_queue_Is_null
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicMessageQueue
+ * @{
+ */
+
+/**
+ * @brief Message_queue_Is_null
*
* This function places the_message at the rear of the outstanding
* messages on the_message_queue.
*/
-
RTEMS_INLINE_ROUTINE boolean _Message_queue_Is_null (
Message_queue_Control *the_message_queue
)
@@ -39,16 +39,12 @@ RTEMS_INLINE_ROUTINE boolean _Message_queue_Is_null (
}
-/*PAGE
- *
- * _Message_queue_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Message_queue_Free
*
* This routine deallocates a message queue control block into
* the inactive chain of free message queue control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Message_queue_Free (
Message_queue_Control *the_message_queue
)
@@ -56,11 +52,8 @@ RTEMS_INLINE_ROUTINE void _Message_queue_Free (
_Objects_Free( &_Message_queue_Information, &the_message_queue->Object );
}
-/*PAGE
- *
- * _Message_queue_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Message_queue_Get
*
* This function maps message queue IDs to message queue control
* blocks. If ID corresponds to a local message queue, then it
@@ -71,7 +64,6 @@ RTEMS_INLINE_ROUTINE void _Message_queue_Free (
* Otherwise, location is set to OBJECTS_ERROR and
* the_message_queue is undefined.
*/
-
RTEMS_INLINE_ROUTINE Message_queue_Control *_Message_queue_Get (
Objects_Id id,
Objects_Locations *location
@@ -81,5 +73,7 @@ RTEMS_INLINE_ROUTINE Message_queue_Control *_Message_queue_Get (
_Objects_Get( &_Message_queue_Information, id, location );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/modes.inl b/cpukit/rtems/inline/rtems/rtems/modes.inl
index eef7a3d9f3..9656de2dab 100644
--- a/cpukit/rtems/inline/rtems/rtems/modes.inl
+++ b/cpukit/rtems/inline/rtems/rtems/modes.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/modes.inl
- */
-
-/*
+ *
* This include file contains the static inline implementation of the
* inlined routines in the Mode Handler
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,16 +18,17 @@
#ifndef _RTEMS_RTEMS_MODES_INL
#define _RTEMS_RTEMS_MODES_INL
-/*PAGE
- *
- * _Modes_Mask_changed
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicModes
+ * @{
+ */
+
+/**
+ * @brief Modes_Mask_changed
*
* This function returns TRUE if any of the mode flags in mask
* are set in mode_set, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Modes_Mask_changed (
Modes_Control mode_set,
Modes_Control masks
@@ -37,16 +37,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Mask_changed (
return ( mode_set & masks );
}
-/*PAGE
- *
- * _Modes_Is_asr_disabled
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Is_asr_disabled
*
* This function returns TRUE if mode_set indicates that Asynchronous
* Signal Processing is disabled, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Modes_Is_asr_disabled (
Modes_Control mode_set
)
@@ -54,16 +50,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_asr_disabled (
return (mode_set & RTEMS_ASR_MASK) == RTEMS_NO_ASR;
}
-/*PAGE
- *
- * _Modes_Is_preempt
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Is_preempt
*
* This function returns TRUE if mode_set indicates that preemption
* is enabled, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Modes_Is_preempt (
Modes_Control mode_set
)
@@ -71,16 +63,12 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_preempt (
return (mode_set & RTEMS_PREEMPT_MASK) == RTEMS_PREEMPT;
}
-/*PAGE
- *
- * _Modes_Is_timeslice
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Is_timeslice
*
* This function returns TRUE if mode_set indicates that timeslicing
* is enabled, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Modes_Is_timeslice (
Modes_Control mode_set
)
@@ -88,15 +76,11 @@ RTEMS_INLINE_ROUTINE boolean _Modes_Is_timeslice (
return (mode_set & RTEMS_TIMESLICE_MASK) == RTEMS_TIMESLICE;
}
-/*PAGE
- *
- * _Modes_Get_interrupt_level
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Get_interrupt_level
*
* This function returns the interrupt level portion of the mode_set.
*/
-
RTEMS_INLINE_ROUTINE ISR_Level _Modes_Get_interrupt_level (
Modes_Control mode_set
)
@@ -104,16 +88,12 @@ RTEMS_INLINE_ROUTINE ISR_Level _Modes_Get_interrupt_level (
return ( mode_set & RTEMS_INTERRUPT_MASK );
}
-/*PAGE
- *
- * _Modes_Set_interrupt_level
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Set_interrupt_level
*
* This routine sets the current interrupt level to that specified
* in the mode_set.
*/
-
RTEMS_INLINE_ROUTINE void _Modes_Set_interrupt_level (
Modes_Control mode_set
)
@@ -121,18 +101,14 @@ RTEMS_INLINE_ROUTINE void _Modes_Set_interrupt_level (
_ISR_Set_level( _Modes_Get_interrupt_level( mode_set ) );
}
-/*PAGE
- *
- * _Modes_Change
- *
- * DESCRIPTION:
+/**
+ * @brief Modes_Change
*
* This routine changes the modes in old_mode_set indicated by
* mask to the requested values in new_mode_set. The resulting
* mode set is returned in out_mode_set and the modes that changed
* is returned in changed.
*/
-
RTEMS_INLINE_ROUTINE void _Modes_Change (
Modes_Control old_mode_set,
Modes_Control new_mode_set,
@@ -150,5 +126,7 @@ RTEMS_INLINE_ROUTINE void _Modes_Change (
*out_mode_set = _out_mode;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/options.inl b/cpukit/rtems/inline/rtems/rtems/options.inl
index 1aa5ba6e0d..7bc10de9ca 100644
--- a/cpukit/rtems/inline/rtems/rtems/options.inl
+++ b/cpukit/rtems/inline/rtems/rtems/options.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/options.inl
- */
-
-/*
+ *
* This file contains the static inline implementation of the inlined
* routines from the Options Handler.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,16 +18,17 @@
#ifndef _RTEMS_RTEMS_OPTIONS_INL
#define _RTEMS_RTEMS_OPTIONS_INL
-/*PAGE
- *
- * _Options_Is_no_wait
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicOptions
+ * @{
+ */
+
+/**
+ * @brief Options_Is_no_wait
*
* This function returns TRUE if the RTEMS_NO_WAIT option is enabled in
* option_set, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Options_Is_no_wait (
rtems_option option_set
)
@@ -36,16 +36,12 @@ RTEMS_INLINE_ROUTINE boolean _Options_Is_no_wait (
return (option_set & RTEMS_NO_WAIT);
}
-/*PAGE
- *
- * _Options_Is_any
- *
- * DESCRIPTION:
+/**
+ * @brief Options_Is_any
*
* This function returns TRUE if the RTEMS_EVENT_ANY option is enabled in
* OPTION_SET, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Options_Is_any (
rtems_option option_set
)
@@ -53,5 +49,7 @@ RTEMS_INLINE_ROUTINE boolean _Options_Is_any (
return (option_set & RTEMS_EVENT_ANY);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/part.inl b/cpukit/rtems/inline/rtems/rtems/part.inl
index 1e8f3b2f8d..7674c48e18 100644
--- a/cpukit/rtems/inline/rtems/rtems/part.inl
+++ b/cpukit/rtems/inline/rtems/rtems/part.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/part.inl
- */
-
-/*
+ *
* This file contains the macro implementation of all inlined routines
* in the Partition Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,17 +18,18 @@
#ifndef _RTEMS_RTEMS_PART_INL
#define _RTEMS_RTEMS_PART_INL
-/*PAGE
- *
- * _Partition_Allocate_buffer
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicPart
+ * @{
+ */
+
+/**
+ * @brief Partition_Allocate_buffer
*
* This function attempts to allocate a buffer from the_partition.
* If successful, it returns the address of the allocated buffer.
* Otherwise, it returns NULL.
*/
-
RTEMS_INLINE_ROUTINE void *_Partition_Allocate_buffer (
Partition_Control *the_partition
)
@@ -37,15 +37,11 @@ RTEMS_INLINE_ROUTINE void *_Partition_Allocate_buffer (
return _Chain_Get( &the_partition->Memory );
}
-/*PAGE
- *
- * _Partition_Free_buffer
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Free_buffer
*
* This routine frees the_buffer to the_partition.
*/
-
RTEMS_INLINE_ROUTINE void _Partition_Free_buffer (
Partition_Control *the_partition,
Chain_Node *the_buffer
@@ -54,16 +50,12 @@ RTEMS_INLINE_ROUTINE void _Partition_Free_buffer (
_Chain_Append( &the_partition->Memory, the_buffer );
}
-/*PAGE
- *
- * _Partition_Is_buffer_on_boundary
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Is_buffer_on_boundary
*
* This function returns TRUE if the_buffer is on a valid buffer
* boundary for the_partition, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_on_boundary (
void *the_buffer,
Partition_Control *the_partition
@@ -79,16 +71,12 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_on_boundary (
return ((offset % the_partition->buffer_size) == 0);
}
-/*PAGE
- *
- * _Partition_Is_buffer_valid
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Is_buffer_valid
*
* This function returns TRUE if the_buffer is a valid buffer from
* the_partition, otherwise FALSE is returned.
*/
-
RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_valid (
Chain_Node *the_buffer,
Partition_Control *the_partition
@@ -106,17 +94,13 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_valid (
);
}
-/*PAGE
- *
- * _Partition_Is_buffer_size_aligned
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Is_buffer_size_aligned
*
* This function returns TRUE if the use of the specified buffer_size
* will result in the allocation of buffers whose first byte is
* properly aligned, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_size_aligned (
uint32_t buffer_size
)
@@ -124,31 +108,23 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_buffer_size_aligned (
return ((buffer_size % CPU_PARTITION_ALIGNMENT) == 0);
}
-/*PAGE
- *
- * _Partition_Allocate
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Allocate
*
* This function allocates a partition control block from
* the inactive chain of free partition control blocks.
*/
-
RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Allocate ( void )
{
return (Partition_Control *) _Objects_Allocate( &_Partition_Information );
}
-/*PAGE
- *
- * _Partition_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Free
*
* This routine frees a partition control block to the
* inactive chain of free partition control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Partition_Free (
Partition_Control *the_partition
)
@@ -156,11 +132,8 @@ RTEMS_INLINE_ROUTINE void _Partition_Free (
_Objects_Free( &_Partition_Information, &the_partition->Object );
}
-/*PAGE
- *
- * _Partition_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Get
*
* This function maps partition IDs to partition control blocks.
* If ID corresponds to a local partition, then it returns
@@ -170,7 +143,6 @@ RTEMS_INLINE_ROUTINE void _Partition_Free (
* and the_partition is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_partition is undefined.
*/
-
RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Get (
Objects_Id id,
Objects_Locations *location
@@ -180,16 +152,12 @@ RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Get (
_Objects_Get( &_Partition_Information, id, location );
}
-/*PAGE
- *
- * _Partition_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Partition_Is_null
*
* This function returns TRUE if the_partition is NULL
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Partition_Is_null (
Partition_Control *the_partition
)
@@ -197,5 +165,7 @@ RTEMS_INLINE_ROUTINE boolean _Partition_Is_null (
return ( the_partition == NULL );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/ratemon.inl b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
index bae2940617..7f2d9703fd 100644
--- a/cpukit/rtems/inline/rtems/rtems/ratemon.inl
+++ b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/ratemon.inl
- */
-
-/*
+ *
* This file contains the static inline implementation of the inlined
* routines in the Rate Monotonic Manager.
- *
- * COPYRIGHT (c) 1989-2007.
+ */
+
+/* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,32 +18,29 @@
#ifndef _RTEMS_RTEMS_RATEMON_INL
#define _RTEMS_RTEMS_RATEMON_INL
-/*PAGE
- *
- * _Rate_monotonic_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicRateMon
+ * @{
+ */
+
+/**
+ * @brief Rate_monotonic_Allocate
*
* This function allocates a period control block from
* the inactive chain of free period control blocks.
*/
-
RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Allocate( void )
{
return (Rate_monotonic_Control *)
_Objects_Allocate( &_Rate_monotonic_Information );
}
-/*PAGE
- *
- * _Rate_monotonic_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Free
*
* This routine allocates a period control block from
* the inactive chain of free period control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
Rate_monotonic_Control *the_period
)
@@ -52,11 +48,8 @@ RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
_Objects_Free( &_Rate_monotonic_Information, &the_period->Object );
}
-/*PAGE
- *
- * _Rate_monotonic_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Get
*
* This function maps period IDs to period control blocks.
* If ID corresponds to a local period, then it returns
@@ -64,7 +57,6 @@ RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
* is set to OBJECTS_LOCAL. Otherwise, location is set
* to OBJECTS_ERROR and the_period is undefined.
*/
-
RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Get (
Objects_Id id,
Objects_Locations *location
@@ -74,16 +66,12 @@ RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Get (
_Objects_Get( &_Rate_monotonic_Information, id, location );
}
-/*PAGE
- *
- * _Rate_monotonic_Is_active
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Is_active
*
* This function returns TRUE if the_period is in the ACTIVE state,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_active (
Rate_monotonic_Control *the_period
)
@@ -91,16 +79,12 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_active (
return (the_period->state == RATE_MONOTONIC_ACTIVE);
}
-/*PAGE
- *
- * _Rate_monotonic_Is_inactive
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Is_inactive
*
* This function returns TRUE if the_period is in the ACTIVE state,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_inactive (
Rate_monotonic_Control *the_period
)
@@ -108,16 +92,12 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_inactive (
return (the_period->state == RATE_MONOTONIC_INACTIVE);
}
-/*PAGE
- *
- * _Rate_monotonic_Is_expired
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Is_expired
*
* This function returns TRUE if the_period is in the EXPIRED state,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_expired (
Rate_monotonic_Control *the_period
)
@@ -125,15 +105,11 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_expired (
return (the_period->state == RATE_MONOTONIC_EXPIRED);
}
-/*PAGE
- *
- * _Rate_monotonic_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Rate_monotonic_Is_null
*
* This function returns TRUE if the_period is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_null (
Rate_monotonic_Control *the_period
)
@@ -141,5 +117,7 @@ RTEMS_INLINE_ROUTINE boolean _Rate_monotonic_Is_null (
return (the_period == NULL);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/region.inl b/cpukit/rtems/inline/rtems/rtems/region.inl
index 412efec203..efc77f8db2 100644
--- a/cpukit/rtems/inline/rtems/rtems/region.inl
+++ b/cpukit/rtems/inline/rtems/rtems/region.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/region.inl
- */
-
-/*
+ *
* This file contains the macro implementation of the inlined
* routines from the Region Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
#ifndef _RTEMS_RTEMS_REGION_INL
#define _RTEMS_RTEMS_REGION_INL
-/*PAGE
- *
- * _Region_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicRegion
+ * @{
+ */
+
+/**
+ * @brief Region_Allocate
*
* This function allocates a region control block from
* the inactive chain of free region control blocks.
*/
-
RTEMS_INLINE_ROUTINE Region_Control *_Region_Allocate( void )
{
return (Region_Control *) _Objects_Allocate( &_Region_Information );
}
-/*PAGE
- *
- * _Region_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Free
*
* This routine frees a region control block to the
* inactive chain of free region control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Region_Free (
Region_Control *the_region
)
@@ -51,11 +47,8 @@ RTEMS_INLINE_ROUTINE void _Region_Free (
_Objects_Free( &_Region_Information, &the_region->Object );
}
-/*PAGE
- *
- * _Region_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Get
*
* This function maps region IDs to region control blocks.
* If ID corresponds to a local region, then it returns
@@ -63,7 +56,6 @@ RTEMS_INLINE_ROUTINE void _Region_Free (
* is set to OBJECTS_LOCAL. Otherwise, location is set
* to OBJECTS_ERROR and the_region is undefined.
*/
-
RTEMS_INLINE_ROUTINE Region_Control *_Region_Get (
Objects_Id id,
Objects_Locations *location
@@ -73,17 +65,13 @@ RTEMS_INLINE_ROUTINE Region_Control *_Region_Get (
_Objects_Get_no_protection( &_Region_Information, id, location );
}
-/*PAGE
- *
- * _Region_Allocate_segment
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Allocate_segment
*
* This function attempts to allocate a segment from the_region.
* If successful, it returns the address of the allocated segment.
* Otherwise, it returns NULL.
*/
-
RTEMS_INLINE_ROUTINE void *_Region_Allocate_segment (
Region_Control *the_region,
uint32_t size
@@ -92,15 +80,11 @@ RTEMS_INLINE_ROUTINE void *_Region_Allocate_segment (
return _Heap_Allocate( &the_region->Memory, size );
}
-/*PAGE
- *
- * _Region_Free_segment
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Free_segment
*
* This function frees the_segment to the_region.
*/
-
RTEMS_INLINE_ROUTINE boolean _Region_Free_segment (
Region_Control *the_region,
void *the_segment
@@ -109,15 +93,11 @@ RTEMS_INLINE_ROUTINE boolean _Region_Free_segment (
return _Heap_Free( &the_region->Memory, the_segment );
}
-/*PAGE
- *
- * _Region_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Region_Is_null
*
* This function returns TRUE if the_region is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Region_Is_null (
Region_Control *the_region
)
diff --git a/cpukit/rtems/inline/rtems/rtems/sem.inl b/cpukit/rtems/inline/rtems/rtems/sem.inl
index fd1924017f..3ae3666faf 100644
--- a/cpukit/rtems/inline/rtems/rtems/sem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/sem.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/sem.inl
- */
-
-/*
+ *
* This file contains the static inlin implementation of the inlined
* routines from the Semaphore Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
#ifndef _RTEMS_RTEMS_SEM_INL
#define _RTEMS_RTEMS_SEM_INL
-/*PAGE
- *
- * _Semaphore_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicSem
+ * @{
+ */
+
+/**
+ * @brief Semaphore_Allocate
*
* This function allocates a semaphore control block from
* the inactive chain of free semaphore control blocks.
*/
-
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Allocate( void )
{
return (Semaphore_Control *) _Objects_Allocate( &_Semaphore_Information );
}
-/*PAGE
- *
- * _Semaphore_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Semaphore_Free
*
* This routine frees a semaphore control block to the
* inactive chain of free semaphore control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Semaphore_Free (
Semaphore_Control *the_semaphore
)
@@ -51,11 +47,8 @@ RTEMS_INLINE_ROUTINE void _Semaphore_Free (
_Objects_Free( &_Semaphore_Information, &the_semaphore->Object );
}
-/*PAGE
- *
- * _Semaphore_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Semaphore_Get
*
* This function maps semaphore IDs to semaphore control blocks.
* If ID corresponds to a local semaphore, then it returns
@@ -65,7 +58,6 @@ RTEMS_INLINE_ROUTINE void _Semaphore_Free (
* and the_semaphore is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_semaphore is undefined.
*/
-
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get (
Objects_Id id,
Objects_Locations *location
@@ -85,15 +77,11 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get_interrupt_disable (
_Objects_Get_isr_disable( &_Semaphore_Information, id, location, level );
}
-/*PAGE
- *
- * _Semaphore_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Semaphore_Is_null
*
* This function returns TRUE if the_semaphore is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Semaphore_Is_null (
Semaphore_Control *the_semaphore
)
@@ -101,5 +89,7 @@ RTEMS_INLINE_ROUTINE boolean _Semaphore_Is_null (
return ( the_semaphore == NULL );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/status.inl b/cpukit/rtems/inline/rtems/rtems/status.inl
index c1e5d998cb..cf8bfffeea 100644
--- a/cpukit/rtems/inline/rtems/rtems/status.inl
+++ b/cpukit/rtems/inline/rtems/rtems/status.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/status.inl
- */
-
-/*
+ *
* This include file contains the implementations of the inlined
* routines for the status package.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,16 +18,17 @@
#ifndef _RTEMS_RTEMS_STATUS_INL
#define _RTEMS_RTEMS_STATUS_INL
-/*PAGE
- *
- * rtems_is_status_successful
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicStatus
+ * @{
+ */
+
+/**
+ * @brief tems_is_status_successful
*
* This function returns TRUE if the status code is equal to RTEMS_SUCCESSFUL,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean rtems_is_status_successful(
rtems_status_code code
)
@@ -36,16 +36,12 @@ RTEMS_INLINE_ROUTINE boolean rtems_is_status_successful(
return (code == RTEMS_SUCCESSFUL);
}
-/*PAGE
- *
- * rtems_are_statuses_equal
- *
- * DESCRIPTION:
+/**
+ * @brief tems_are_statuses_equal
*
* This function returns TRUE if the status code1 is equal to code2,
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean rtems_are_statuses_equal(
rtems_status_code code1,
rtems_status_code code2
@@ -54,5 +50,7 @@ RTEMS_INLINE_ROUTINE boolean rtems_are_statuses_equal(
return (code1 == code2);
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/support.inl b/cpukit/rtems/inline/rtems/rtems/support.inl
index 4c507b0daf..f8c24aef05 100644
--- a/cpukit/rtems/inline/rtems/rtems/support.inl
+++ b/cpukit/rtems/inline/rtems/rtems/support.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/support.inl
- */
-
-/*
+ *
* This include file contains the static inline implementation of all
* of the inlined routines specific to the RTEMS API.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,15 +18,16 @@
#ifndef _RTEMS_RTEMS_SUPPORT_INL
#define _RTEMS_RTEMS_SUPPORT_INL
-/*PAGE
- *
+/**
+ * @addtogroup ClassicSupport
+ * @{
+ */
+
+/**
* rtems_is_name_valid
*
- * DESCRIPTION:
- *
* This function returns TRUE if the name is valid, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE rtems_boolean rtems_is_name_valid (
rtems_name name
)
@@ -35,16 +35,12 @@ RTEMS_INLINE_ROUTINE rtems_boolean rtems_is_name_valid (
return ( name != 0 );
}
-/*PAGE
- *
+/**
* rtems_name_to_characters
*
- * DESCRIPTION:
- *
* This function breaks the object name into the four component
* characters C1, C2, C3, and C4.
*/
-
RTEMS_INLINE_ROUTINE void rtems_name_to_characters(
rtems_name name,
char *c1,
@@ -59,5 +55,7 @@ RTEMS_INLINE_ROUTINE void rtems_name_to_characters(
*c4 = name & 0xff;
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/tasks.inl b/cpukit/rtems/inline/rtems/rtems/tasks.inl
index 143662c609..4b705c2e24 100644
--- a/cpukit/rtems/inline/rtems/rtems/tasks.inl
+++ b/cpukit/rtems/inline/rtems/rtems/tasks.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/tasks.inl
- */
-
-/*
+ *
* This file contains the static inline implementation of all inlined
* routines in the with RTEMS Tasks Manager.
- *
- * COPYRIGHT (c) 1989-2008.
+ */
+
+/* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
#ifndef _RTEMS_RTEMS_TASKS_INL
#define _RTEMS_RTEMS_TASKS_INL
-/*PAGE
- *
- * _RTEMS_tasks_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicTasks
+ * @{
+ */
+
+/**
+ * @brief RTEMS_tasks_Allocate
*
* This function allocates a task control block from
* the inactive chain of free task control blocks.
*/
-
RTEMS_INLINE_ROUTINE Thread_Control *_RTEMS_tasks_Allocate( void )
{
return (Thread_Control *) _Objects_Allocate( &_RTEMS_tasks_Information );
}
-/*PAGE
- *
- * _RTEMS_tasks_Free
- *
- * DESCRIPTION:
+/**
+ * @brief RTEMS_tasks_Free
*
* This routine frees a task control block to the
* inactive chain of free task control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _RTEMS_tasks_Free (
Thread_Control *the_task
)
@@ -54,15 +50,11 @@ RTEMS_INLINE_ROUTINE void _RTEMS_tasks_Free (
);
}
-/*PAGE
- *
- * _RTEMS_tasks_Priority_to_Core
- *
- * DESCRIPTION:
+/**
+ * @brief RTEMS_tasks_Priority_to_Core
*
* This function converts an RTEMS API priority into a core priority.
*/
-
RTEMS_INLINE_ROUTINE Priority_Control _RTEMS_tasks_Priority_to_Core(
rtems_task_priority priority
)
@@ -70,16 +62,12 @@ RTEMS_INLINE_ROUTINE Priority_Control _RTEMS_tasks_Priority_to_Core(
return (Priority_Control) priority;
}
-/*PAGE
- *
- * _RTEMS_tasks_Priority_is_valid
- *
- * DESCRIPTION:
+/**
+ * @brief RTEMS_tasks_Priority_is_valid
*
* This function returns TRUE if the_priority is a valid user task priority
* and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _RTEMS_tasks_Priority_is_valid (
rtems_task_priority the_priority
)
@@ -88,5 +76,7 @@ RTEMS_INLINE_ROUTINE boolean _RTEMS_tasks_Priority_is_valid (
( the_priority <= RTEMS_MAXIMUM_PRIORITY ) );
}
+/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/rtems/inline/rtems/rtems/timer.inl b/cpukit/rtems/inline/rtems/rtems/timer.inl
index 6660af6e40..884e46e2b5 100644
--- a/cpukit/rtems/inline/rtems/rtems/timer.inl
+++ b/cpukit/rtems/inline/rtems/rtems/timer.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/timer.inl
- */
-
-/*
+ *
* This file contains the static inline implementation of the inlined routines
* from the Timer Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -19,31 +18,28 @@
#ifndef _RTEMS_RTEMS_TIMER_INL
#define _RTEMS_RTEMS_TIMER_INL
-/*PAGE
- *
- * _Timer_Allocate
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicTimer
+ * @{
+ */
+
+/**
+ * @brief Timer_Allocate
*
* This function allocates a timer control block from
* the inactive chain of free timer control blocks.
*/
-
RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Allocate( void )
{
return (Timer_Control *) _Objects_Allocate( &_Timer_Information );
}
-/*PAGE
- *
- * _Timer_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Free
*
* This routine frees a timer control block to the
* inactive chain of free timer control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Timer_Free (
Timer_Control *the_timer
)
@@ -51,11 +47,8 @@ RTEMS_INLINE_ROUTINE void _Timer_Free (
_Objects_Free( &_Timer_Information, &the_timer->Object );
}
-/*PAGE
- *
- * _Timer_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Get
*
* This function maps timer IDs to timer control blocks.
* If ID corresponds to a local timer, then it returns
@@ -63,7 +56,6 @@ RTEMS_INLINE_ROUTINE void _Timer_Free (
* is set to OBJECTS_LOCAL. Otherwise, location is set
* to OBJECTS_ERROR and the returned value is undefined.
*/
-
RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Get (
Objects_Id id,
Objects_Locations *location
@@ -73,16 +65,12 @@ RTEMS_INLINE_ROUTINE Timer_Control *_Timer_Get (
_Objects_Get( &_Timer_Information, id, location );
}
-/*PAGE
- *
- * _Timer_Is_interval_class
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Is_interval_class
*
* This function returns TRUE if the class is that of an INTERVAL
* timer, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Timer_Is_interval_class (
Timer_Classes the_class
)
@@ -90,16 +78,12 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_interval_class (
return (the_class == TIMER_INTERVAL) || (the_class == TIMER_INTERVAL_ON_TASK);
}
-/*PAGE
- *
- * _Timer_Is_time_of_day_class
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Is_time_of_day_class
*
* This function returns TRUE if the class is that of an INTERVAL
* timer, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Timer_Is_timer_of_day_class (
Timer_Classes the_class
)
@@ -107,16 +91,12 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_timer_of_day_class (
return ( the_class == TIMER_TIME_OF_DAY );
}
-/*PAGE
- *
- * _Timer_Is_dormant_class
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Is_dormant_class
*
* This function returns TRUE if the class is that of a DORMANT
* timer, and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Timer_Is_dormant_class (
Timer_Classes the_class
)
@@ -124,15 +104,11 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_dormant_class (
return ( the_class == TIMER_DORMANT );
}
-/*PAGE
- *
- * _Timer_Is_null
- *
- * DESCRIPTION:
+/**
+ * @brief Timer_Is_null
*
* This function returns TRUE if the_timer is NULL and FALSE otherwise.
*/
-
RTEMS_INLINE_ROUTINE boolean _Timer_Is_null (
Timer_Control *the_timer
)
@@ -140,5 +116,7 @@ RTEMS_INLINE_ROUTINE boolean _Timer_Is_null (
return ( the_timer == NULL );
}
+/**@}*/
+
#endif
/* end of include file */