[rtems commit] score: Doxygen Clean Up Task #17
Jennifer Averett
jennifer at rtems.org
Wed Jan 9 13:54:17 UTC 2013
Module: rtems
Branch: master
Commit: 1f0d013dd21d8b65584affaa6e9992fe637b676e
Changeset: http://git.rtems.org/rtems/commit/?id=1f0d013dd21d8b65584affaa6e9992fe637b676e
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Wed Jan 9 07:56:28 2013 -0600
score: Doxygen Clean Up Task #17
---
cpukit/score/cpu/nios2/rtems/asm.h | 21 +-
cpukit/score/cpu/nios2/rtems/score/nios2-utility.h | 10 +-
cpukit/score/cpu/nios2/rtems/score/nios2.h | 17 +-
cpukit/score/inline/rtems/score/chain.inl | 389 +++++++++++---------
cpukit/score/inline/rtems/score/corebarrier.inl | 34 +-
cpukit/score/inline/rtems/score/coremsg.inl | 77 ++--
cpukit/score/inline/rtems/score/corerwlock.inl | 22 +-
cpukit/score/inline/rtems/score/coresem.inl | 61 ++--
cpukit/score/inline/rtems/score/corespinlock.inl | 31 +-
cpukit/score/inline/rtems/score/isr.inl | 25 +-
cpukit/score/inline/rtems/score/mppkt.inl | 29 +-
cpukit/score/inline/rtems/score/object.inl | 192 +++++-----
cpukit/score/inline/rtems/score/objectmp.inl | 23 +-
cpukit/score/inline/rtems/score/scheduler.inl | 114 ++++---
cpukit/score/inline/rtems/score/stack.inl | 47 ++--
cpukit/score/inline/rtems/score/states.inl | 215 ++++++------
cpukit/score/inline/rtems/score/sysstate.inl | 12 +-
cpukit/score/inline/rtems/score/thread.inl | 150 ++++----
cpukit/score/inline/rtems/score/tod.inl | 23 +-
cpukit/score/inline/rtems/score/tqdata.inl | 35 +-
20 files changed, 818 insertions(+), 709 deletions(-)
diff --git a/cpukit/score/cpu/nios2/rtems/asm.h b/cpukit/score/cpu/nios2/rtems/asm.h
index 0725d7c..45ccd8b 100644
--- a/cpukit/score/cpu/nios2/rtems/asm.h
+++ b/cpukit/score/cpu/nios2/rtems/asm.h
@@ -1,17 +1,20 @@
/**
- * @file rtems/asm.h
+ * @file
*
- * This include file attempts to address the problems
- * caused by incompatible flavors of assemblers and
- * toolsets. It primarily addresses variations in the
- * use of leading underscores on symbols and the requirement
- * that register names be preceded by a %.
+ * @brief Address the Problems Caused by Incompatible Flavor of
+ * Assemblers and Toolsets
+ *
+ * This include file attempts to address the problems
+ * caused by incompatible flavors of assemblers and
+ * toolsets. It primarily addresses variations in the
+ * use of leading underscores on symbols and the requirement
+ * that register names be preceded by a %.
+ *
+ * @note The spacing in the use of these macros
+ * is critical to them working as advertised.
*/
/*
- * NOTE: The spacing in the use of these macros
- * is critical to them working as advertised.
- *
* COPYRIGHT:
*
* This file is based on similar code found in newlib available
diff --git a/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h b/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
index b99dd02..078484f 100644
--- a/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
+++ b/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
@@ -1,3 +1,8 @@
+/**
+ * @file
+ *
+ * @brief NIOS II Utility
+ */
/*
* Copyright (c) 2011 embedded brains GmbH. All rights reserved.
*
@@ -496,9 +501,8 @@ static inline void _Nios2_MPU_Restore( uint32_t config )
_Nios2_Set_ctlreg_config( config );
}
-/*
- * @brief Nios2 MPU Disable Protected
- *
+/**
+ * @brief Nios2 MPU disable protected.
*/
uint32_t _Nios2_MPU_Disable_protected( void );
diff --git a/cpukit/score/cpu/nios2/rtems/score/nios2.h b/cpukit/score/cpu/nios2/rtems/score/nios2.h
index 9fd8bff..9a8e232 100644
--- a/cpukit/score/cpu/nios2/rtems/score/nios2.h
+++ b/cpukit/score/cpu/nios2/rtems/score/nios2.h
@@ -1,11 +1,16 @@
-/* nios2.h
- *
- * This file sets up basic CPU dependency settings based on
- * compiler settings. For example, it can determine if
- * floating point is available. This particular implementation
- * is specific to the NIOS2 port.
+/**
+ * @file
*
+ * @brief NIOS II Set up Basic CPU Dependency Settings Based on
+ * Compiler Settings
*
+ * This file sets up basic CPU dependency settings based on
+ * compiler settings. For example, it can determine if
+ * floating point is available. This particular implementation
+ * is specific to the NIOS2 port.
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/score/inline/rtems/score/chain.inl b/cpukit/score/inline/rtems/score/chain.inl
index ebef695..d122415 100644
--- a/cpukit/score/inline/rtems/score/chain.inl
+++ b/cpukit/score/inline/rtems/score/chain.inl
@@ -1,9 +1,7 @@
/**
* @file
*
- * @ingroup ScoreChain
- *
- * @brief Chain Handler API.
+ * @brief Chain Handler API
*/
/*
@@ -25,16 +23,18 @@
#define _RTEMS_SCORE_CHAIN_INL
/**
- * @addtogroup ScoreChain
- * @{
+ * @addtogroup ScoreChain
+ *
+ * @{
*/
-/** @brief Set off chain
+/**
+ * @brief Set off chain.
*
- * This function sets the next and previous fields of the @a node to NULL
- * indicating the @a node is not part of a chain.
+ * This function sets the next and previous fields of the @a node to NULL
+ * indicating the @a node is not part of a chain.
*
- * @param[in] node the node set to off chain.
+ * @param[in] node the node set to off chain.
*/
RTEMS_INLINE_ROUTINE void _Chain_Set_off_chain(
Chain_Node *node
@@ -43,14 +43,16 @@ RTEMS_INLINE_ROUTINE void _Chain_Set_off_chain(
node->next = node->previous = NULL;
}
-/** @brief Is the Node off Chain
+/**
+ * @brief Is the node off chain.
*
- * This function returns true if the @a node is not on a chain. A @a node is
- * off chain if the next and previous fields are set to NULL.
+ * This function returns true if the @a node is not on a chain. A @a node is
+ * off chain if the next and previous fields are set to NULL.
*
- * @param[in] node is the node off chain.
+ * @param[in] node is the node off chain.
*
- * @return This function returns true if the @a node is off chain.
+ * @retval true The @a node is off chain.
+ * @retval false The @a node is not off chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_node_off_chain(
const Chain_Node *node
@@ -59,16 +61,17 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_node_off_chain(
return (node->next == NULL) && (node->previous == NULL);
}
-/** @brief Are Two Nodes Equal
+/**
+ * @brief Are two nodes equal.
*
- * This function returns true if @a left and @a right are equal,
- * and false otherwise.
+ * This function returns true if @a left and @a right are equal,
+ * and false otherwise.
*
- * @param[in] left is the node on the left hand side of the comparison.
- * @param[in] right is the node on the left hand side of the comparison.
+ * @param[in] left is the node on the left hand side of the comparison.
+ * @param[in] right is the node on the left hand side of the comparison.
*
- * @return This function returns true if @a left and @a right are equal,
- * and false otherwise.
+ * @retval true @a left and @a right are equal.
+ * @retval false @a left and @a right are not equal.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Are_nodes_equal(
const Chain_Node *left,
@@ -78,13 +81,15 @@ RTEMS_INLINE_ROUTINE bool _Chain_Are_nodes_equal(
return left == right;
}
-/** @brief Is this Chain Control Pointer Null
+/**
+ * @brief Is this chain control pointer NULL.
*
- * This function returns true if the_chain is NULL and false otherwise.
+ * This function returns true if the_chain is NULL and false otherwise.
*
- * @param[in] the_chain is the chain to be checked for empty status.
+ * @param[in] the_chain is the chain to be checked for empty status.
*
- * @return This method returns true if the_chain is NULL and false otherwise.
+ * @retval true @a the_chain is @c NULL.
+ * @retval false @a the_chain is not @c NULL.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_null(
const Chain_Control *the_chain
@@ -93,13 +98,15 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_null(
return (the_chain == NULL);
}
-/** @brief Is the Chain Node Pointer NULL
+/**
+ * @brief Is the chain node pointer NULL.
*
- * This function returns true if the_node is NULL and false otherwise.
+ * This function returns true if the_node is NULL and false otherwise.
*
- * @param[in] the_node is the node pointer to check.
+ * @param[in] the_node is the node pointer to check.
*
- * @return This method returns true if the_node is NULL and false otherwise.
+ * @retval true @a the_node is @c NULL.
+ * @retval false @a the_node is not @c NULL.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_null_node(
const Chain_Node *the_node
@@ -108,13 +115,14 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_null_node(
return (the_node == NULL);
}
-/** @brief Return pointer to Chain Head
+/**
+ * @brief Return pointer to chain head.
*
- * This function returns a pointer to the head node on the chain.
+ * This function returns a pointer to the head node on the chain.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the permanent head node of the chain.
+ * @return This method returns the permanent head node of the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
Chain_Control *the_chain
@@ -123,13 +131,14 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
return &the_chain->Head.Node;
}
-/** @brief Return pointer to immutable Chain Head
+/**
+ * @brief Return pointer to immutable chain head.
*
- * This function returns a pointer to the head node on the chain.
+ * This function returns a pointer to the head node on the chain.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the permanent head node of the chain.
+ * @return This method returns the permanent head node of the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_head(
const Chain_Control *the_chain
@@ -138,13 +147,14 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_head(
return &the_chain->Head.Node;
}
-/** @brief Return pointer to Chain Tail
+/**
+ * @brief Return pointer to chain tail.
*
- * This function returns a pointer to the tail node on the chain.
+ * This function returns a pointer to the tail node on the chain.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the permanent tail node of the chain.
+ * @return This method returns the permanent tail node of the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
Chain_Control *the_chain
@@ -153,13 +163,14 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
return &the_chain->Tail.Node;
}
-/** @brief Return pointer to immutable Chain Tail
+/**
+ * @brief Return pointer to immutable chain tail.
*
- * This function returns a pointer to the tail node on the chain.
+ * This function returns a pointer to the tail node on the chain.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the permanent tail node of the chain.
+ * @return This method returns the permanent tail node of the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_tail(
const Chain_Control *the_chain
@@ -168,14 +179,15 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_tail(
return &the_chain->Tail.Node;
}
-/** @brief Return pointer to Chain's First node
+/**
+ * @brief Return pointer to chain's first node.
*
- * This function returns a pointer to the first node on the chain after the
- * head.
+ * This function returns a pointer to the first node on the chain after the
+ * head.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the first node of the chain.
+ * @return This method returns the first node of the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_First(
Chain_Control *the_chain
@@ -184,14 +196,15 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_First(
return _Chain_Head( the_chain )->next;
}
-/** @brief Return pointer to immutable Chain's First node
+/**
+ * @brief Return pointer to immutable chain's first node.
*
- * This function returns a pointer to the first node on the chain after the
- * head.
+ * This function returns a pointer to the first node on the chain after the
+ * head.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the first node of the chain.
+ * @return This method returns the first node of the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_first(
const Chain_Control *the_chain
@@ -200,14 +213,15 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_first(
return _Chain_Immutable_head( the_chain )->next;
}
-/** @brief Return pointer to Chain's Last node
+/**
+ * @brief Return pointer to chain's last node.
*
- * This function returns a pointer to the last node on the chain just before
- * the tail.
+ * This function returns a pointer to the last node on the chain just before
+ * the tail.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the last node of the chain.
+ * @return This method returns the last node of the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Last(
Chain_Control *the_chain
@@ -216,14 +230,15 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Last(
return _Chain_Tail( the_chain )->previous;
}
-/** @brief Return pointer to immutable Chain's Last node
+/**
+ * @brief Return pointer to immutable chain's last node.
*
- * This function returns a pointer to the last node on the chain just before
- * the tail.
+ * This function returns a pointer to the last node on the chain just before
+ * the tail.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This method returns the last node of the chain.
+ * @return This method returns the last node of the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_last(
const Chain_Control *the_chain
@@ -232,13 +247,14 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_last(
return _Chain_Immutable_tail( the_chain )->previous;
}
-/** @brief Return pointer the next node from this node
+/**
+ * @brief Return pointer the next node from this node.
*
- * This function returns a pointer to the next node after this node.
+ * This function returns a pointer to the next node after this node.
*
- * @param[in] the_node is the node to be operated upon.
+ * @param[in] the_node is the node to be operated upon.
*
- * @return This method returns the next node on the chain.
+ * @return This method returns the next node on the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Next(
Chain_Node *the_node
@@ -247,13 +263,14 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Next(
return the_node->next;
}
-/** @brief Return pointer the immutable next node from this node
+/**
+ * @brief Return pointer the immutable next node from this node.
*
- * This function returns a pointer to the next node after this node.
+ * This function returns a pointer to the next node after this node.
*
- * @param[in] the_node is the node to be operated upon.
+ * @param[in] the_node is the node to be operated upon.
*
- * @return This method returns the next node on the chain.
+ * @return This method returns the next node on the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_next(
const Chain_Node *the_node
@@ -262,13 +279,14 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_next(
return the_node->next;
}
-/** @brief Return pointer the previous node from this node
+/**
+ * @brief Return pointer the previous node from this node.
*
- * This function returns a pointer to the previous node on this chain.
+ * This function returns a pointer to the previous node on this chain.
*
- * @param[in] the_node is the node to be operated upon.
+ * @param[in] the_node is the node to be operated upon.
*
- * @return This method returns the previous node on the chain.
+ * @return This method returns the previous node on the chain.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Previous(
Chain_Node *the_node
@@ -277,13 +295,14 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Previous(
return the_node->previous;
}
-/** @brief Return pointer the immutable previous node from this node
+/**
+ * @brief Return pointer the immutable previous node from this node.
*
- * This function returns a pointer to the previous node on this chain.
+ * This function returns a pointer to the previous node on this chain.
*
- * @param[in] the_node is the node to be operated upon.
+ * @param[in] the_node is the node to be operated upon.
*
- * @return This method returns the previous node on the chain.
+ * @return This method returns the previous node on the chain.
*/
RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_previous(
const Chain_Node *the_node
@@ -292,15 +311,16 @@ RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_previous(
return the_node->previous;
}
-/** @brief Is the Chain Empty
+/**
+ * @brief Is the chain empty.
*
- * This function returns true if there a no nodes on @a the_chain and
- * false otherwise.
+ * This function returns true if there a no nodes on @a the_chain and
+ * false otherwise.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @return This function returns true if there a no nodes on @a the_chain and
- * false otherwise.
+ * @retval true There are no nodes on @a the_chain.
+ * @retval false There are nodes on @a the_chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_empty(
const Chain_Control *the_chain
@@ -310,16 +330,17 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_empty(
== _Chain_Immutable_tail( the_chain );
}
-/** @brief Is this the First Node on the Chain
+/**
+ * @brief Is this the first node on the chain.
*
- * This function returns true if the_node is the first node on a chain and
- * false otherwise.
+ * This function returns true if the_node is the first node on a chain and
+ * false otherwise.
*
- * @param[in] the_node is the node the caller wants to know if it is
- * the first node on a chain.
+ * @param[in] the_node is the node the caller wants to know if it is
+ * the first node on a chain.
*
- * @return This function returns true if @a the_node is the first node on
- * a chain and false otherwise.
+ * @retval true @a the_node is the first node on a chain.
+ * @retval false @a the_node is not the first node on a chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_first(
const Chain_Node *the_node
@@ -328,15 +349,16 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_first(
return (the_node->previous->previous == NULL);
}
-/** @brief Is this the Last Node on the Chain
+/**
+ * @brief Is this the last node on the chain.
*
- * This function returns true if @a the_node is the last node on a chain and
- * false otherwise.
+ * This function returns true if @a the_node is the last node on a chain and
+ * false otherwise.
*
- * @param[in] the_node is the node to check as the last node.
+ * @param[in] the_node is the node to check as the last node.
*
- * @return This function returns true if @a the_node is the last node on
- * a chain and false otherwise.
+ * @retval true @a the_node is the last node on a chain.
+ * @retval false @a the_node is not the last node on a chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_last(
const Chain_Node *the_node
@@ -345,15 +367,19 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_last(
return (the_node->next->next == NULL);
}
-/** @brief Does this Chain have only One Node
+/**
+ * @brief Does this chain have only one node.
+ *
+ * This function returns true if there is only one node on @a the_chain and
+ * false otherwise.
*
- * This function returns true if there is only one node on @a the_chain and
- * false otherwise.
+ * @param[in] the_chain is the chain to be operated upon.
*
- * @param[in] the_chain is the chain to be operated upon.
+ * @return This function returns true if there is only one node on
+ * @a the_chain and false otherwise.
*
- * @return This function returns true if there is only one node on
- * @a the_chain and false otherwise.
+ * @retval true There is only one node on @a the_chain.
+ * @retval false There is more than one node on @a the_chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Has_only_one_node(
const Chain_Control *the_chain
@@ -363,16 +389,17 @@ RTEMS_INLINE_ROUTINE bool _Chain_Has_only_one_node(
== _Chain_Immutable_last( the_chain );
}
-/** @brief Is this Node the Chain Head
+/**
+ * @brief Is this node the chain head.
*
- * This function returns true if @a the_node is the head of the_chain and
- * false otherwise.
+ * This function returns true if @a the_node is the head of @a the_chain and
+ * false otherwise.
*
- * @param[in] the_chain is the chain to be operated upon.
- * @param[in] the_node is the node to check for being the Chain Head.
+ * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_node is the node to check for being the Chain Head.
*
- * @return This function returns true if @a the_node is the head of
- * @a the_chain and false otherwise.
+ * @retval true @a the_node is the head of @a the_chain.
+ * @retval false @a the_node is not the head of @a the_chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_head(
const Chain_Control *the_chain,
@@ -382,13 +409,17 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_head(
return (the_node == _Chain_Immutable_head( the_chain ));
}
-/** @brief Is this Node the Chail Tail
+/**
+ * @brief Is this node the chail tail.
*
- * This function returns true if the_node is the tail of the_chain and
- * false otherwise.
+ * This function returns true if @a the_node is the tail of @a the_chain and
+ * false otherwise.
*
- * @param[in] the_chain is the chain to be operated upon.
- * @param[in] the_node is the node to check for being the Chain Tail.
+ * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_node is the node to check for being the Chain Tail.
+ *
+ * @retval true @a the_node is the tail of @a the_chain.
+ * @retval false @a the_node is not the tail of @a the_chain.
*/
RTEMS_INLINE_ROUTINE bool _Chain_Is_tail(
const Chain_Control *the_chain,
@@ -398,11 +429,12 @@ RTEMS_INLINE_ROUTINE bool _Chain_Is_tail(
return (the_node == _Chain_Immutable_tail( the_chain ));
}
-/** @brief Initialize this Chain as Empty
+/**
+ * @brief Initialize this chain as empty.
*
- * This routine initializes the specified chain to contain zero nodes.
+ * This routine initializes the specified chain to contain zero nodes.
*
- * @param[in] the_chain is the chain to be initialized.
+ * @param[in] the_chain is the chain to be initialized.
*/
RTEMS_INLINE_ROUTINE void _Chain_Initialize_empty(
Chain_Control *the_chain
@@ -416,13 +448,14 @@ RTEMS_INLINE_ROUTINE void _Chain_Initialize_empty(
tail->previous = head;
}
-/** @brief Extract this Node (unprotected)
+/**
+ * @brief Extract this node (unprotected).
*
- * This routine extracts the_node from the chain on which it resides.
- * It does NOT disable interrupts to ensure the atomicity of the
- * extract operation.
+ * This routine extracts the_node from the chain on which it resides.
+ * It does NOT disable interrupts to ensure the atomicity of the
+ * extract operation.
*
- * @param[in] the_node is the node to be extracted.
+ * @param[in] the_node is the node to be extracted.
*/
RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
Chain_Node *the_node
@@ -437,19 +470,20 @@ RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
previous->next = next;
}
-/** @brief Get the First Node (unprotected)
+/**
+ * @brief Get the first node (unprotected).
*
- * This function removes the first node from the_chain and returns
- * a pointer to that node. It does NOT disable interrupts to ensure
- * the atomicity of the get operation.
+ * This function removes the first node from the_chain and returns
+ * a pointer to that node. It does NOT disable interrupts to ensure
+ * the atomicity of the get operation.
*
- * @param[in] the_chain is the chain to attempt to get the first node from.
+ * @param[in] the_chain is the chain to attempt to get the first node from.
*
- * @return This method returns the first node on the chain even if it is
- * the Chain Tail.
+ * @return This method returns the first node on the chain even if it is
+ * the Chain Tail.
*
- * @note This routine assumes that there is at least one node on the chain
- * and always returns a node even if it is the Chain Tail.
+ * @note This routine assumes that there is at least one node on the chain
+ * and always returns a node even if it is the Chain Tail.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
Chain_Control *the_chain
@@ -465,18 +499,19 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
return old_first;
}
-/** @brief Get the First Node (unprotected)
+/**
+ * @brief Get the first node (unprotected).
*
- * This function removes the first node from the_chain and returns
- * a pointer to that node. If the_chain is empty, then NULL is returned.
+ * This function removes the first node from the_chain and returns
+ * a pointer to that node. If the_chain is empty, then NULL is returned.
*
- * @param[in] the_chain is the chain to attempt to get the first node from.
+ * @param[in] the_chain is the chain to attempt to get the first node from.
*
- * @return This method returns the first node on the chain or NULL if the
- * chain is empty.
+ * @return This method returns the first node on the chain or NULL if the
+ * chain is empty.
*
- * @note It does NOT disable interrupts to ensure the atomicity of the
- * get operation.
+ * @note It does NOT disable interrupts to ensure the atomicity of the
+ * get operation.
*/
RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
Chain_Control *the_chain
@@ -488,17 +523,18 @@ RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
return NULL;
}
-/** @brief Insert a Node (unprotected)
+/**
+ * @brief Insert a node (unprotected).
*
- * This routine inserts the_node on a chain immediately following
- * after_node.
+ * This routine inserts the_node on a chain immediately following
+ * after_node.
*
- * @param[in] after_node is the node which will precede @a the_node on the
- * chain.
- * @param[in] the_node is the node to be inserted.
+ * @param[in] after_node is the node which will precede @a the_node on the
+ * chain.
+ * @param[in] the_node is the node to be inserted.
*
- * @note It does NOT disable interrupts to ensure the atomicity
- * of the extract operation.
+ * @note It does NOT disable interrupts to ensure the atomicity
+ * of the extract operation.
*/
RTEMS_INLINE_ROUTINE void _Chain_Insert_unprotected(
Chain_Node *after_node,
@@ -514,15 +550,16 @@ RTEMS_INLINE_ROUTINE void _Chain_Insert_unprotected(
before_node->previous = the_node;
}
-/** @brief Append a Node (unprotected)
+/**
+ * @brief Append a node (unprotected).
*
- * This routine appends the_node onto the end of the_chain.
+ * This routine appends the_node onto the end of the_chain.
*
- * @param[in] the_chain is the chain to be operated upon.
- * @param[in] the_node is the node to be appended.
+ * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_node is the node to be appended.
*
- * @note It does NOT disable interrupts to ensure the atomicity of the
- * append operation.
+ * @note It does NOT disable interrupts to ensure the atomicity of the
+ * append operation.
*/
RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
Chain_Control *the_chain,
@@ -539,13 +576,13 @@ RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
}
/**
- * @brief Append a node on the end of a chain if the node is in the off chain
- * state (unprotected).
+ * @brief Append a node on the end of a chain if the node is in the off chain
+ * state (unprotected).
*
- * @note It does NOT disable interrupts to ensure the atomicity of the
- * append operation.
+ * @note It does NOT disable interrupts to ensure the atomicity of the
+ * append operation.
*
- * @see _Chain_Append_unprotected() and _Chain_Is_node_off_chain().
+ * @see _Chain_Append_unprotected() and _Chain_Is_node_off_chain().
*/
RTEMS_INLINE_ROUTINE void _Chain_Append_if_is_off_chain_unprotected(
Chain_Control *the_chain,
@@ -557,15 +594,16 @@ RTEMS_INLINE_ROUTINE void _Chain_Append_if_is_off_chain_unprotected(
}
}
-/** @brief Prepend a Node (unprotected)
+/**
+ * @brief Prepend a node (unprotected).
*
- * This routine prepends the_node onto the front of the_chain.
+ * This routine prepends the_node onto the front of the_chain.
*
- * @param[in] the_chain is the chain to be operated upon.
- * @param[in] the_node is the node to be prepended.
+ * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_node is the node to be prepended.
*
- * @note It does NOT disable interrupts to ensure the atomicity of the
- * prepend operation.
+ * @note It does NOT disable interrupts to ensure the atomicity of the
+ * prepend operation.
*/
RTEMS_INLINE_ROUTINE void _Chain_Prepend_unprotected(
Chain_Control *the_chain,
@@ -575,15 +613,16 @@ RTEMS_INLINE_ROUTINE void _Chain_Prepend_unprotected(
_Chain_Insert_unprotected(_Chain_Head(the_chain), the_node);
}
-/** @brief Prepend a Node (protected)
+/**
+ * @brief Prepend a node (protected).
*
- * This routine prepends the_node onto the front of the_chain.
+ * This routine prepends the_node onto the front of the_chain.
*
- * @param[in] the_chain is the chain to be operated upon.
- * @param[in] the_node is the node to be prepended.
+ * @param[in] the_chain is the chain to be operated upon.
+ * @param[in] the_node is the node to be prepended.
*
- * @note It disables interrupts to ensure the atomicity of the
- * prepend operation.
+ * @note It disables interrupts to ensure the atomicity of the
+ * prepend operation.
*/
RTEMS_INLINE_ROUTINE void _Chain_Prepend(
Chain_Control *the_chain,
@@ -688,7 +727,7 @@ RTEMS_INLINE_ROUTINE bool _Chain_Get_with_empty_check_unprotected(
return is_empty_now;
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/corebarrier.inl b/cpukit/score/inline/rtems/score/corebarrier.inl
index 1af0515..5c41179 100644
--- a/cpukit/score/inline/rtems/score/corebarrier.inl
+++ b/cpukit/score/inline/rtems/score/corebarrier.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/corebarrier.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with the SuperCore Barrier
*
- * This include file contains all of the inlined routines associated
- * with the SuperCore barrier.
+ * This include file contains all of the inlined routines associated
+ * with the SuperCore barrier.
*/
/*
@@ -22,19 +24,21 @@
#define _RTEMS_SCORE_COREBARRIER_INL
/**
- * @addtogroup ScoreBarrier
- * @{
+ * @addtogroup ScoreBarrier
+ *
+ * @{
*/
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
/**
- * This function returns true if the automatic release attribute is
- * enabled in the @a attribute_set and false otherwise.
+ * This function returns true if the automatic release attribute is
+ * enabled in the @a attribute_set and false otherwise.
+ *
+ * @param[in] the_attribute is the attribute set to test
*
- * @param[in] the_attribute is the attribute set to test
- * @return true if the priority attribute is enabled
+ * @return true if the priority attribute is enabled
*/
RTEMS_INLINE_ROUTINE bool _CORE_barrier_Is_automatic(
CORE_barrier_Attributes *the_attribute
@@ -45,11 +49,11 @@ RTEMS_INLINE_ROUTINE bool _CORE_barrier_Is_automatic(
}
/**
- * This routine returns the number of threads currently waiting at the barrier.
+ * This routine returns the number of threads currently waiting at the barrier.
*
- * @param[in] the_barrier is the barrier to obtain the number of blocked
- * threads for
- * @return the current count of this barrier
+ * @param[in] the_barrier is the barrier to obtain the number of blocked
+ * threads for
+ * @return the current count of this barrier
*/
RTEMS_INLINE_ROUTINE uint32_t _CORE_barrier_Get_number_of_waiting_threads(
CORE_barrier_Control *the_barrier
@@ -58,7 +62,7 @@ RTEMS_INLINE_ROUTINE uint32_t _CORE_barrier_Get_number_of_waiting_threads(
return the_barrier->number_of_waiting_threads;
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/coremsg.inl b/cpukit/score/inline/rtems/score/coremsg.inl
index 0191c3c..2db8c97 100644
--- a/cpukit/score/inline/rtems/score/coremsg.inl
+++ b/cpukit/score/inline/rtems/score/coremsg.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/coremsg.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines in the Core Message Handler
*
- * This include file contains the static inline implementation of all
- * inlined routines in the Core Message Handler.
+ * This include file contains the static inline implementation of all
+ * inlined routines in the Core Message Handler.
*/
/*
@@ -22,14 +24,15 @@
#define _RTEMS_SCORE_COREMSG_INL
/**
- * @addtogroup ScoreMessageQueue
- * @{
+ * @addtogroup ScoreMessageQueue
+ *
+ * @{
*/
#include <string.h> /* needed for memcpy */
-
+
/**
- * This routine sends a message to the end of the specified message queue.
+ * This routine sends a message to the end of the specified message queue.
*/
RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Send(
CORE_message_queue_Control *the_message_queue,
@@ -52,9 +55,9 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Send(
timeout /* timeout interval */
);
}
-
+
/**
- * This routine sends a message to the front of the specified message queue.
+ * This routine sends a message to the front of the specified message queue.
*/
RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Urgent(
CORE_message_queue_Control *the_message_queue,
@@ -79,8 +82,8 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Urgent(
}
/**
- * This routine copies the contents of the source message buffer
- * to the destination message buffer.
+ * This routine copies the contents of the source message buffer
+ * to the destination message buffer.
*/
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Copy_buffer (
const void *source,
@@ -92,8 +95,8 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Copy_buffer (
}
/**
- * This function allocates a message buffer from the inactive
- * message buffer chain.
+ * This function allocates a message buffer from the inactive
+ * message buffer chain.
*/
RTEMS_INLINE_ROUTINE CORE_message_queue_Buffer_control *
_CORE_message_queue_Allocate_message_buffer (
@@ -105,8 +108,8 @@ _CORE_message_queue_Allocate_message_buffer (
}
/**
- * This routine frees a message buffer to the inactive
- * message buffer chain.
+ * This routine frees a message buffer to the inactive
+ * message buffer chain.
*/
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Free_message_buffer (
CORE_message_queue_Control *the_message_queue,
@@ -117,10 +120,10 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Free_message_buffer (
}
/**
- * This function returns the priority of @a the_message.
+ * This function returns the priority of @a the_message.
*
- * NOTE: It encapsulates the optional behavior that message priority is
- * disabled if no API requires it.
+ * @note It encapsulates the optional behavior that message priority is
+ * disabled if no API requires it.
*/
RTEMS_INLINE_ROUTINE int _CORE_message_queue_Get_message_priority (
CORE_message_queue_Buffer_control *the_message
@@ -134,14 +137,14 @@ RTEMS_INLINE_ROUTINE int _CORE_message_queue_Get_message_priority (
}
/**
- * This function sets the priority of @a the_message.
+ * This function sets the priority of @a the_message.
*
- * NOTE: It encapsulates the optional behavior that message priority is
- * disabled if no API requires it.
+ * @note It encapsulates the optional behavior that message priority is
+ * disabled if no API requires it.
*/
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_message_priority (
CORE_message_queue_Buffer_control *the_message,
- int priority
+ int priority
)
{
#if defined(RTEMS_SCORE_COREMSG_ENABLE_MESSAGE_PRIORITY)
@@ -150,8 +153,8 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_message_priority (
}
/**
- * This function removes the first message from the_message_queue
- * and returns a pointer to it.
+ * This function removes the first message from the_message_queue
+ * and returns a pointer to it.
*/
RTEMS_INLINE_ROUTINE
CORE_message_queue_Buffer_control *_CORE_message_queue_Get_pending_message (
@@ -163,8 +166,8 @@ RTEMS_INLINE_ROUTINE
}
/**
- * This function returns true if the priority attribute is
- * enabled in the attribute_set and false otherwise.
+ * This function returns true if the priority attribute is
+ * enabled in the attribute_set and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_priority(
CORE_message_queue_Attributes *the_attribute
@@ -175,8 +178,8 @@ RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_priority(
}
/**
- * This routine places the_message at the rear of the outstanding
- * messages on the_message_queue.
+ * This routine places the_message at the rear of the outstanding
+ * messages on the_message_queue.
*/
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Append_unprotected (
CORE_message_queue_Control *the_message_queue,
@@ -190,8 +193,8 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Append_unprotected (
}
/**
- * This routine places the_message at the front of the outstanding
- * messages on the_message_queue.
+ * This routine places the_message at the front of the outstanding
+ * messages on the_message_queue.
*/
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Prepend_unprotected (
CORE_message_queue_Control *the_message_queue,
@@ -205,7 +208,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Prepend_unprotected (
}
/**
- * This function returns true if the_message_queue is true and false otherwise.
+ * This function returns true if the_message_queue is true and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_null (
CORE_message_queue_Control *the_message_queue
@@ -216,8 +219,8 @@ RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_null (
#if defined(RTEMS_SCORE_COREMSG_ENABLE_NOTIFICATION)
/**
- * This function returns true if notification is enabled on this message
- * queue and false otherwise.
+ * This function returns true if notification is enabled on this message
+ * queue and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_notify_enabled (
CORE_message_queue_Control *the_message_queue
@@ -228,8 +231,8 @@ RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_null (
#endif
/**
- * This routine initializes the notification information for
- * @a the_message_queue.
+ * This routine initializes the notification information for
+ * @a the_message_queue.
*/
#if defined(RTEMS_SCORE_COREMSG_ENABLE_NOTIFICATION)
RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_notify (
@@ -247,7 +250,7 @@ RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_null (
the_message_queue, the_handler, the_argument )
#endif
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/corerwlock.inl b/cpukit/score/inline/rtems/score/corerwlock.inl
index 8736c0f..c9d499b 100644
--- a/cpukit/score/inline/rtems/score/corerwlock.inl
+++ b/cpukit/score/inline/rtems/score/corerwlock.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/corerwlock.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with the SuperCore RWLock
*
- * This include file contains all of the inlined routines associated
- * with the SuperCore RWLock.
+ * This include file contains all of the inlined routines associated
+ * with the SuperCore RWLock.
*/
/*
@@ -22,18 +24,18 @@
#define _RTEMS_SCORE_CORERWLOCK_INL
/**
- * @addtogroup ScoreRWLock
- * @{
+ * @addtogroup ScoreRWLock
+ *
+ * @{
*/
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
/**
+ * This method is used to initialize core rwlock attributes.
*
- * This method is used to initialize core rwlock attributes.
- *
- * @param[in] the_attributes pointer to the attributes to initialize.
+ * @param[in] the_attributes pointer to the attributes to initialize.
*/
RTEMS_INLINE_ROUTINE void _CORE_RWLock_Initialize_attributes(
CORE_RWLock_Attributes *the_attributes
@@ -43,7 +45,7 @@ RTEMS_INLINE_ROUTINE void _CORE_RWLock_Initialize_attributes(
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/coresem.inl b/cpukit/score/inline/rtems/score/coresem.inl
index f504798..91f4aa1 100644
--- a/cpukit/score/inline/rtems/score/coresem.inl
+++ b/cpukit/score/inline/rtems/score/coresem.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/coresem.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with the SuperCore Semaphore
*
- * This include file contains all of the inlined routines associated
- * with the SuperCore semaphore.
+ * This include file contains all of the inlined routines associated
+ * with the SuperCore semaphore.
*/
/*
@@ -22,19 +24,21 @@
#define _RTEMS_SCORE_CORESEM_INL
/**
- * @addtogroup ScoreSemaphore
- * @{
+ * @addtogroup ScoreSemaphore
+ *
+ * @{
*/
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
/**
- * This function returns true if the priority attribute is
- * enabled in the @a attribute_set and false otherwise.
+ * This function returns true if the priority attribute is
+ * enabled in the @a attribute_set and false otherwise.
+ *
+ * @param[in] the_attribute is the attribute set to test
*
- * @param[in] the_attribute is the attribute set to test
- * @return true if the priority attribute is enabled
+ * @return true if the priority attribute is enabled
*/
RTEMS_INLINE_ROUTINE bool _CORE_semaphore_Is_priority(
CORE_semaphore_Attributes *the_attribute
@@ -44,10 +48,11 @@ RTEMS_INLINE_ROUTINE bool _CORE_semaphore_Is_priority(
}
/**
- * This routine returns the current count associated with the semaphore.
+ * This routine returns the current count associated with the semaphore.
*
- * @param[in] the_semaphore is the semaphore to obtain the count of
- * @return the current count of this semaphore
+ * @param[in] the_semaphore is the semaphore to obtain the count of
+ *
+ * @return the current count of this semaphore
*/
RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count(
CORE_semaphore_Control *the_semaphore
@@ -57,19 +62,19 @@ RTEMS_INLINE_ROUTINE uint32_t _CORE_semaphore_Get_count(
}
/**
- * This routine attempts to receive a unit from the_semaphore.
- * If a unit is available or if the wait flag is false, then the routine
- * returns. Otherwise, the calling task is blocked until a unit becomes
- * available.
+ * This routine attempts to receive a unit from the_semaphore.
+ * If a unit is available or if the wait flag is false, then the routine
+ * returns. Otherwise, the calling task is blocked until a unit becomes
+ * available.
*
- * @param[in] the_semaphore is the semaphore to obtain
- * @param[in] id is the Id of the owning API level Semaphore object
- * @param[in] wait is true if the thread is willing to wait
- * @param[in] timeout is the maximum number of ticks to block
- * @param[in] level_p is a temporary variable used to contain the ISR
- * disable level cookie
+ * @param[in] the_semaphore is the semaphore to obtain
+ * @param[in] id is the Id of the owning API level Semaphore object
+ * @param[in] wait is true if the thread is willing to wait
+ * @param[in] timeout is the maximum number of ticks to block
+ * @param[in] level_p is a temporary variable used to contain the ISR
+ * disable level cookie
*
- * @note There is currently no MACRO version of this routine.
+ * @note There is currently no MACRO version of this routine.
*/
RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
CORE_semaphore_Control *the_semaphore,
@@ -77,12 +82,12 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
bool wait,
Watchdog_Interval timeout,
ISR_Level *level_p
-)
-{
+)
+{
Thread_Control *executing;
/* disabled when you get here */
-
+
executing = _Thread_Executing;
executing->Wait.return_code = CORE_SEMAPHORE_STATUS_SUCCESSFUL;
if ( the_semaphore->count != 0 ) {
@@ -107,7 +112,7 @@ RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
_Thread_Enable_dispatch();
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/corespinlock.inl b/cpukit/score/inline/rtems/score/corespinlock.inl
index f45f320..28f4fc7 100644
--- a/cpukit/score/inline/rtems/score/corespinlock.inl
+++ b/cpukit/score/inline/rtems/score/corespinlock.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/corespinlock.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with the SuperCore Spinlock
*
- * This include file contains all of the inlined routines associated
- * with the SuperCore spinlock.
+ * This include file contains all of the inlined routines associated
+ * with the SuperCore spinlock.
*/
/*
@@ -22,15 +24,15 @@
#define _RTEMS_SCORE_CORESPINLOCK_INL
/**
- * @addtogroup ScoreSpinlock
- * @{
+ * @addtogroup ScoreSpinlock
+ *
+ * @{
*/
/**
+ * This method is used to initialize core spinlock attributes.
*
- * This method is used to initialize core spinlock attributes.
- *
- * @param[in] the_attributes pointer to the attributes to initialize.
+ * @param[in] the_attributes pointer to the attributes to initialize.
*/
RTEMS_INLINE_ROUTINE void _CORE_spinlock_Initialize_attributes(
CORE_spinlock_Attributes *the_attributes
@@ -40,13 +42,12 @@ RTEMS_INLINE_ROUTINE void _CORE_spinlock_Initialize_attributes(
}
/**
+ * This method is used to determine if the spinlock is available or not.
*
- * This method is used to determine if the spinlock is available or not.
- *
- * @param[in] the_spinlock will be checked
+ * @param[in] the_spinlock will be checked
*
- * @return This method will return true if the spinlock is busy
- * and false otherwise.
+ * @return This method will return true if the spinlock is busy
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _CORE_spinlock_Is_busy(
CORE_spinlock_Control *the_spinlock
@@ -55,7 +56,7 @@ RTEMS_INLINE_ROUTINE bool _CORE_spinlock_Is_busy(
return (the_spinlock->users != 0);
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/isr.inl b/cpukit/score/inline/rtems/score/isr.inl
index accc03c..fb450e4 100644
--- a/cpukit/score/inline/rtems/score/isr.inl
+++ b/cpukit/score/inline/rtems/score/isr.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/isr.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines in the Interrupt Handler
*
- * This include file contains the static implementation of all
- * inlined routines in the Interrupt Handler.
+ * This include file contains the static implementation of all
+ * inlined routines in the Interrupt Handler.
*/
/*
@@ -22,14 +24,15 @@
#define _RTEMS_SCORE_ISR_INL
/**
- * @addtogroup ScoreISR
- * @{
+ * @addtogroup ScoreISR
+ *
+ * @{
*/
#if (CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE)
/**
- * This function returns true if the vector is a valid vector number
- * for this processor and false otherwise.
+ * This function returns true if the vector is a valid vector number
+ * for this processor and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _ISR_Is_vector_number_valid (
@@ -40,8 +43,8 @@ RTEMS_INLINE_ROUTINE bool _ISR_Is_vector_number_valid (
}
/**
- * This function returns true if handler is the entry point of a valid
- * use interrupt service routine and false otherwise.
+ * This function returns true if handler is the entry point of a valid
+ * use interrupt service routine and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _ISR_Is_valid_user_handler (
@@ -52,7 +55,7 @@ RTEMS_INLINE_ROUTINE bool _ISR_Is_valid_user_handler (
}
#endif
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/mppkt.inl b/cpukit/score/inline/rtems/score/mppkt.inl
index c832424..2e681cd 100644
--- a/cpukit/score/inline/rtems/score/mppkt.inl
+++ b/cpukit/score/inline/rtems/score/mppkt.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/mppkt.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines from the Packet Handler
*
- * This package is the implementation of the Packet Handler
- * routines which are inlined.
+ * This package is the implementation of the Packet Handler
+ * routines which are inlined.
*/
/*
@@ -22,16 +24,17 @@
#define _RTEMS_SCORE_MPPKT_INL
/**
- * @addtogroup ScoreMPPacket
- * @{
+ * @addtogroup ScoreMPPacket
+ *
+ * @{
*/
/**
- * This function returns true if the the_packet_class is valid,
- * and false otherwise.
+ * This function returns true if the the_packet_class is valid,
+ * and false otherwise.
*
- * @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
- * because this enum starts at lower bound of zero.
+ * @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
+ * because this enum starts at lower bound of zero.
*/
RTEMS_INLINE_ROUTINE bool _Mp_packet_Is_valid_packet_class (
@@ -42,8 +45,8 @@ RTEMS_INLINE_ROUTINE bool _Mp_packet_Is_valid_packet_class (
}
/**
- * This function returns true if the the_packet_class is null,
- * and false otherwise.
+ * This function returns true if the the_packet_class is null,
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Mp_packet_Is_null (
@@ -53,7 +56,7 @@ RTEMS_INLINE_ROUTINE bool _Mp_packet_Is_null (
return the_packet == NULL;
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/object.inl b/cpukit/score/inline/rtems/score/object.inl
index 1f3adcb..726d676 100644
--- a/cpukit/score/inline/rtems/score/object.inl
+++ b/cpukit/score/inline/rtems/score/object.inl
@@ -1,5 +1,7 @@
/**
- * @file rtems/score/object.inl
+ * @file
+ *
+ * @brief Inlined Routines in the Object Handler
*
* This include file contains the static inline implementation of all
* of the inlined routines in the Object Handler.
@@ -22,16 +24,16 @@
#define _RTEMS_SCORE_OBJECT_INL
/**
- * This function builds an object's id from the processor node and index
- * values specified.
+ * This function builds an object's id from the processor node and index
+ * values specified.
*
- * @param[in] the_api indicates the API associated with this Id.
- * @param[in] the_class indicates the class of object.
- * It is specific to @a the_api.
- * @param[in] node is the node where this object resides.
- * @param[in] index is the instance number of this object.
+ * @param[in] the_api indicates the API associated with this Id.
+ * @param[in] the_class indicates the class of object.
+ * It is specific to @a the_api.
+ * @param[in] node is the node where this object resides.
+ * @param[in] index is the instance number of this object.
*
- * @return This method returns an object Id constructed from the arguments.
+ * @return This method returns an object Id constructed from the arguments.
*/
RTEMS_INLINE_ROUTINE Objects_Id _Objects_Build_id(
Objects_APIs the_api,
@@ -49,11 +51,11 @@ RTEMS_INLINE_ROUTINE Objects_Id _Objects_Build_id(
}
/**
- * This function returns the API portion of the ID.
+ * This function returns the API portion of the ID.
*
- * @param[in] id is the object Id to be processed.
+ * @param[in] id is the object Id to be processed.
*
- * @return This method returns an object Id constructed from the arguments.
+ * @return This method returns an object Id constructed from the arguments.
*/
RTEMS_INLINE_ROUTINE Objects_APIs _Objects_Get_API(
Objects_Id id
@@ -63,24 +65,24 @@ RTEMS_INLINE_ROUTINE Objects_APIs _Objects_Get_API(
}
/**
- * This function returns the class portion of the ID.
+ * This function returns the class portion of the ID.
*
- * @param[in] id is the object Id to be processed
+ * @param[in] id is the object Id to be processed
*/
RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_class(
Objects_Id id
)
{
- return (uint32_t)
+ return (uint32_t)
((id >> OBJECTS_CLASS_START_BIT) & OBJECTS_CLASS_VALID_BITS);
}
-
+
/**
- * This function returns the node portion of the ID.
+ * This function returns the node portion of the ID.
*
- * @param[in] id is the object Id to be processed
+ * @param[in] id is the object Id to be processed
*
- * @return This method returns the node portion of an object ID.
+ * @return This method returns the node portion of an object ID.
*/
RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_node(
Objects_Id id
@@ -98,11 +100,11 @@ RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_node(
}
/**
- * This function returns the index portion of the ID.
+ * This function returns the index portion of the ID.
*
- * @param[in] id is the Id to be processed
+ * @param[in] id is the Id to be processed
*
- * @return This method returns the class portion of the specified object ID.
+ * @return This method returns the class portion of the specified object ID.
*/
RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Get_index(
Objects_Id id
@@ -114,12 +116,12 @@ RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Get_index(
}
/**
- * This function returns true if the api is valid.
+ * This function returns true if the api is valid.
*
- * @param[in] the_api is the api portion of an object ID.
+ * @param[in] the_api is the api portion of an object ID.
*
- * @return This method returns true if the specified api value is valid
- * and false otherwise.
+ * @return This method returns true if the specified api value is valid
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Objects_Is_api_valid(
uint32_t the_api
@@ -129,16 +131,16 @@ RTEMS_INLINE_ROUTINE bool _Objects_Is_api_valid(
return false;
return true;
}
-
+
/**
- * This function returns true if the node is of the local object, and
- * false otherwise.
+ * This function returns true if the node is of the local object, and
+ * false otherwise.
*
- * @param[in] node is the node number and corresponds to the node number
- * portion of an object ID.
+ * @param[in] node is the node number and corresponds to the node number
+ * portion of an object ID.
*
- * @return This method returns true if the specified node is the local node
- * and false otherwise.
+ * @return This method returns true if the specified node is the local node
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Objects_Is_local_node(
uint32_t node
@@ -148,15 +150,15 @@ RTEMS_INLINE_ROUTINE bool _Objects_Is_local_node(
}
/**
- * This function returns true if the id is of a local object, and
- * false otherwise.
+ * This function returns true if the id is of a local object, and
+ * false otherwise.
*
- * @param[in] id is an object ID
+ * @param[in] id is an object ID
*
- * @return This method returns true if the specified object Id is local
- * and false otherwise.
+ * @return This method returns true if the specified object Id is local
+ * and false otherwise.
*
- * @note On a single processor configuration, this always returns true.
+ * @note On a single processor configuration, this always returns true.
*/
RTEMS_INLINE_ROUTINE bool _Objects_Is_local_id(
#if defined(RTEMS_MULTIPROCESSING)
@@ -174,14 +176,14 @@ RTEMS_INLINE_ROUTINE bool _Objects_Is_local_id(
}
/**
- * This function returns true if left and right are equal,
- * and false otherwise.
+ * This function returns true if left and right are equal,
+ * and false otherwise.
*
- * @param[in] left is the Id on the left hand side of the comparison
- * @param[in] right is the Id on the right hand side of the comparison
+ * @param[in] left is the Id on the left hand side of the comparison
+ * @param[in] right is the Id on the right hand side of the comparison
*
- * @return This method returns true if the specified object IDs are equal
- * and false otherwise.
+ * @return This method returns true if the specified object IDs are equal
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Objects_Are_ids_equal(
Objects_Id left,
@@ -192,14 +194,14 @@ RTEMS_INLINE_ROUTINE bool _Objects_Are_ids_equal(
}
/**
- * This function returns a pointer to the local_table object
- * referenced by the index.
+ * This function returns a pointer to the local_table object
+ * referenced by the index.
*
- * @param[in] information points to an Object Information Table
- * @param[in] index is the index of the object the caller wants to access
+ * @param[in] information points to an Object Information Table
+ * @param[in] index is the index of the object the caller wants to access
*
- * @return This method returns a pointer to a local object or NULL if the
- * index is invalid and RTEMS_DEBUG is enabled.
+ * @return This method returns a pointer to a local object or NULL if the
+ * index is invalid and RTEMS_DEBUG is enabled.
*/
RTEMS_INLINE_ROUTINE Objects_Control *_Objects_Get_local_object(
Objects_Information *information,
@@ -207,10 +209,10 @@ RTEMS_INLINE_ROUTINE Objects_Control *_Objects_Get_local_object(
)
{
/*
- * This routine is ONLY to be called from places in the code
- * where the Id is known to be good. Therefore, this should NOT
- * occur in normal situations.
- */
+ * This routine is ONLY to be called from places in the code
+ * where the Id is known to be good. Therefore, this should NOT
+ * occur in normal situations.
+ */
#if defined(RTEMS_DEBUG)
if ( index > information->maximum )
return NULL;
@@ -219,17 +221,17 @@ RTEMS_INLINE_ROUTINE Objects_Control *_Objects_Get_local_object(
}
/**
- * This function sets the pointer to the local_table object
- * referenced by the index.
+ * This function sets the pointer to the local_table object
+ * referenced by the index.
*
- * @param[in] information points to an Object Information Table
- * @param[in] index is the index of the object the caller wants to access
- * @param[in] the_object is the local object pointer
+ * @param[in] information points to an Object Information Table
+ * @param[in] index is the index of the object the caller wants to access
+ * @param[in] the_object is the local object pointer
*
- * @note This routine is ONLY to be called in places where the
- * index portion of the Id is known to be good. This is
- * OK since it is normally called from object create/init
- * or delete/destroy operations.
+ * @note This routine is ONLY to be called in places where the
+ * index portion of the Id is known to be good. This is
+ * OK since it is normally called from object create/init
+ * or delete/destroy operations.
*/
RTEMS_INLINE_ROUTINE void _Objects_Set_local_object(
@@ -242,7 +244,7 @@ RTEMS_INLINE_ROUTINE void _Objects_Set_local_object(
* This routine is ONLY to be called from places in the code
* where the Id is known to be good. Therefore, this should NOT
* occur in normal situations.
- */
+ */
#if defined(RTEMS_DEBUG)
if ( index > information->maximum )
return;
@@ -252,17 +254,17 @@ RTEMS_INLINE_ROUTINE void _Objects_Set_local_object(
}
/**
- * This function sets the pointer to the local_table object
- * referenced by the index to a NULL so the object Id is invalid
- * after this call.
+ * This function sets the pointer to the local_table object
+ * referenced by the index to a NULL so the object Id is invalid
+ * after this call.
*
- * @param[in] information points to an Object Information Table
- * @param[in] the_object is the local object pointer
+ * @param[in] information points to an Object Information Table
+ * @param[in] the_object is the local object pointer
*
- * @note This routine is ONLY to be called in places where the
- * index portion of the Id is known to be good. This is
- * OK since it is normally called from object create/init
- * or delete/destroy operations.
+ * @note This routine is ONLY to be called in places where the
+ * index portion of the Id is known to be good. This is
+ * OK since it is normally called from object create/init
+ * or delete/destroy operations.
*/
RTEMS_INLINE_ROUTINE void _Objects_Invalidate_Id(
@@ -278,12 +280,12 @@ RTEMS_INLINE_ROUTINE void _Objects_Invalidate_Id(
}
/**
- * This function places the_object control pointer and object name
- * in the Local Pointer and Local Name Tables, respectively.
+ * This function places the_object control pointer and object name
+ * in the Local Pointer and Local Name Tables, respectively.
*
- * @param[in] information points to an Object Information Table
- * @param[in] the_object is a pointer to an object
- * @param[in] name is the name of the object to make accessible
+ * @param[in] information points to an Object Information Table
+ * @param[in] the_object is a pointer to an object
+ * @param[in] name is the name of the object to make accessible
*/
RTEMS_INLINE_ROUTINE void _Objects_Open(
Objects_Information *information,
@@ -301,12 +303,12 @@ RTEMS_INLINE_ROUTINE void _Objects_Open(
}
/**
- * This function places the_object control pointer and object name
- * in the Local Pointer and Local Name Tables, respectively.
+ * This function places the_object control pointer and object name
+ * in the Local Pointer and Local Name Tables, respectively.
*
- * @param[in] information points to an Object Information Table
- * @param[in] the_object is a pointer to an object
- * @param[in] name is the name of the object to make accessible
+ * @param[in] information points to an Object Information Table
+ * @param[in] the_object is a pointer to an object
+ * @param[in] name is the name of the object to make accessible
*/
RTEMS_INLINE_ROUTINE void _Objects_Open_u32(
Objects_Information *information,
@@ -320,17 +322,17 @@ RTEMS_INLINE_ROUTINE void _Objects_Open_u32(
the_object
);
- /* ASSERT: information->is_string == false */
+ /* ASSERT: information->is_string == false */
the_object->name.name_u32 = name;
}
/**
- * This function places the_object control pointer and object name
- * in the Local Pointer and Local Name Tables, respectively.
+ * This function places the_object control pointer and object name
+ * in the Local Pointer and Local Name Tables, respectively.
*
- * @param[in] information points to an Object Information Table
- * @param[in] the_object is a pointer to an object
- * @param[in] name is the name of the object to make accessible
+ * @param[in] information points to an Object Information Table
+ * @param[in] the_object is a pointer to an object
+ * @param[in] name is the name of the object to make accessible
*/
RTEMS_INLINE_ROUTINE void _Objects_Open_string(
Objects_Information *information,
@@ -345,18 +347,18 @@ RTEMS_INLINE_ROUTINE void _Objects_Open_string(
);
#if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)
- /* ASSERT: information->is_string */
+ /* ASSERT: information->is_string */
the_object->name.name_p = name;
#endif
}
/**
- * Returns if the object maximum specifies unlimited objects.
+ * Returns if the object maximum specifies unlimited objects.
*
- * @param[in] maximum The object maximum specification.
+ * @param[in] maximum The object maximum specification.
*
- * @retval true Unlimited objects are available.
- * @retval false The object count is fixed.
+ * @retval true Unlimited objects are available.
+ * @retval false The object count is fixed.
*/
RTEMS_INLINE_ROUTINE bool _Objects_Is_unlimited( uint32_t maximum )
{
diff --git a/cpukit/score/inline/rtems/score/objectmp.inl b/cpukit/score/inline/rtems/score/objectmp.inl
index 502c946..48e59d0 100644
--- a/cpukit/score/inline/rtems/score/objectmp.inl
+++ b/cpukit/score/inline/rtems/score/objectmp.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/objectmp.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with Global Objects
*
- * This include file contains the bodies of all inlined routines
- * which deal with global objects.
+ * This include file contains the bodies of all inlined routines
+ * which deal with global objects.
*/
/*
@@ -22,12 +24,13 @@
#define _RTEMS_SCORE_OBJECTMP_INL
/**
- * @addtogroup ScoreObjectMP
- * @{
+ * @addtogroup ScoreObjectMP
+ *
+ * @{
*/
/**
- * This function allocates a Global Object control block.
+ * This function allocates a Global Object control block.
*/
RTEMS_INLINE_ROUTINE Objects_MP_Control *_Objects_MP_Allocate_global_object (
@@ -39,7 +42,7 @@ RTEMS_INLINE_ROUTINE Objects_MP_Control *_Objects_MP_Allocate_global_object (
}
/**
- * This routine deallocates a Global Object control block.
+ * This routine deallocates a Global Object control block.
*/
RTEMS_INLINE_ROUTINE void _Objects_MP_Free_global_object (
@@ -53,7 +56,7 @@ RTEMS_INLINE_ROUTINE void _Objects_MP_Free_global_object (
}
/**
- * This function returns whether the global object is NULL or not.
+ * This function returns whether the global object is NULL or not.
*/
RTEMS_INLINE_ROUTINE bool _Objects_MP_Is_null_global_object (
@@ -63,7 +66,7 @@ RTEMS_INLINE_ROUTINE bool _Objects_MP_Is_null_global_object (
return( the_object == NULL );
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/scheduler.inl b/cpukit/score/inline/rtems/score/scheduler.inl
index 227cabc..fcb9f19 100644
--- a/cpukit/score/inline/rtems/score/scheduler.inl
+++ b/cpukit/score/inline/rtems/score/scheduler.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/scheduler.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with the Manipulation of the Scheduler
*
- * This inline file contains all of the inlined routines associated with
- * the manipulation of the scheduler.
+ * This inline file contains all of the inlined routines associated with
+ * the manipulation of the scheduler.
*/
/*
@@ -22,135 +24,146 @@
#define _RTEMS_SCORE_SCHEDULER_INL
/**
- * @addtogroup ScoreScheduler
+ * @addtogroup ScoreScheduler
+ *
* @{
*/
/**
- * The preferred method to add a new scheduler is to define the jump table
- * entries and add a case to the _Scheduler_Initialize routine.
+ * The preferred method to add a new scheduler is to define the jump table
+ * entries and add a case to the _Scheduler_Initialize routine.
*
- * Generic scheduling implementations that rely on the ready queue only can
+ * Generic scheduling implementations that rely on the ready queue only can
* be found in the _Scheduler_queue_XXX functions.
- *
*/
-/* Passing the Scheduler_Control* to these functions allows for multiple
- * scheduler's to exist simultaneously, which could be useful on an SMP
- * system. Then remote Schedulers may be accessible. How to protect such
+/*
+ * Passing the Scheduler_Control* to these functions allows for multiple
+ * scheduler's to exist simultaneously, which could be useful on an SMP
+ * system. Then remote Schedulers may be accessible. How to protect such
* accesses remains an open problem.
*/
-/** @brief _Scheduler_Schedule
+/**
+ * @brief Scheduler schedule.
*
- * This kernel routine implements the scheduling decision logic for
- * the scheduler. It does NOT dispatch.
+ * This kernel routine implements the scheduling decision logic for
+ * the scheduler. It does NOT dispatch.
*/
RTEMS_INLINE_ROUTINE void _Scheduler_Schedule( void )
{
_Scheduler.Operations.schedule();
}
-/** @brief _Scheduler_Yield
+/**
+ * @brief Scheduler yield.
*
- * This routine is invoked when a thread wishes to voluntarily
- * transfer control of the processor to another thread. This routine
- * always operates on the scheduler that 'owns' the currently executing
- * thread.
+ * This routine is invoked when a thread wishes to voluntarily
+ * transfer control of the processor to another thread. This routine
+ * always operates on the scheduler that 'owns' the currently executing
+ * thread.
*/
RTEMS_INLINE_ROUTINE void _Scheduler_Yield( void )
{
_Scheduler.Operations.yield();
}
-/** @brief _Scheduler_Block
+/**
+ * @brief Scheduler block.
*
- * This routine removes @a the_thread from the scheduling decision for
- * the scheduler. The primary task is to remove the thread from the
- * ready queue. It performs any necessary schedulering operations
- * including the selection of a new heir thread.
+ * This routine removes @a the_thread from the scheduling decision for
+ * the scheduler. The primary task is to remove the thread from the
+ * ready queue. It performs any necessary schedulering operations
+ * including the selection of a new heir thread.
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Block(
- Thread_Control *the_thread
+RTEMS_INLINE_ROUTINE void _Scheduler_Block(
+ Thread_Control *the_thread
)
{
_Scheduler.Operations.block( the_thread );
}
-/** @brief _Scheduler_Unblock
+/**
+ * @brief Scheduler unblock.
*
- * This routine adds @a the_thread to the scheduling decision for
- * the scheduler. The primary task is to add the thread to the
- * ready queue per the schedulering policy and update any appropriate
- * scheduling variables, for example the heir thread.
+ * This routine adds @a the_thread to the scheduling decision for
+ * the scheduler. The primary task is to add the thread to the
+ * ready queue per the schedulering policy and update any appropriate
+ * scheduling variables, for example the heir thread.
*/
RTEMS_INLINE_ROUTINE void _Scheduler_Unblock(
- Thread_Control *the_thread
+ Thread_Control *the_thread
)
{
_Scheduler.Operations.unblock( the_thread );
}
-/** @brief _Scheduler_Allocate
+/**
+ * @brief Scheduler allocate.
*
* This routine allocates @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void* _Scheduler_Allocate(
+RTEMS_INLINE_ROUTINE void* _Scheduler_Allocate(
Thread_Control *the_thread
)
{
return _Scheduler.Operations.allocate( the_thread );
}
-/** @brief _Scheduler_Free
+/**
+ * @brief Scheduler free.
*
* This routine frees @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Free(
+RTEMS_INLINE_ROUTINE void _Scheduler_Free(
Thread_Control *the_thread
)
{
return _Scheduler.Operations.free( the_thread );
}
-/** @brief _Scheduler_Update
+/**
+ * @brief Scheduler update.
*
* This routine updates @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Update(
+RTEMS_INLINE_ROUTINE void _Scheduler_Update(
Thread_Control *the_thread
)
{
_Scheduler.Operations.update( the_thread );
}
-/** @brief _Scheduler_Enqueue
+/**
+ * @brief Scheduler enqueue.
*
* This routine enqueue @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue(
+RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue(
Thread_Control *the_thread
)
{
_Scheduler.Operations.enqueue( the_thread );
}
-/** @brief _Scheduler_Enqueue_first
+/**
+ * @brief Scheduler enqueue first.
*
* This routine enqueue_first @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue_first(
+RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue_first(
Thread_Control *the_thread
)
{
_Scheduler.Operations.enqueue_first( the_thread );
}
-/** @brief _Scheduler_Extract
+/**
+ * @brief Scheduler extract.
*
* This routine extract @a the_thread->scheduler
*/
-RTEMS_INLINE_ROUTINE void _Scheduler_Extract(
+RTEMS_INLINE_ROUTINE void _Scheduler_Extract(
Thread_Control *the_thread
)
{
@@ -158,7 +171,7 @@ RTEMS_INLINE_ROUTINE void _Scheduler_Extract(
}
/**
- * @brief Scheduler Priority compare
+ * @brief Scheduler priority compare.
*
* This routine compares two priorities.
*/
@@ -171,7 +184,7 @@ RTEMS_INLINE_ROUTINE int _Scheduler_Priority_compare(
}
/**
- * @brief Scheduler Release job
+ * @brief Scheduler release job.
*
* This routine is called when a new period of task is issued.
*/
@@ -183,10 +196,11 @@ RTEMS_INLINE_ROUTINE void _Scheduler_Release_job(
_Scheduler.Operations.release_job(the_thread, length);
}
-/** @brief Scheduler Method Invoked at Each Clock Tick
+/**
+ * @brief Scheduler method invoked at each clock tick.
*
* This method is invoked at each clock tick to allow the scheduler
- * implementation to perform any activities required. For the
+ * implementation to perform any activities required. For the
* scheduler which support standard RTEMS features, this includes
* time-slicing management.
*/
@@ -195,7 +209,7 @@ RTEMS_INLINE_ROUTINE void _Scheduler_Tick( void )
_Scheduler.Operations.tick();
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/stack.inl b/cpukit/score/inline/rtems/score/stack.inl
index 2f60f0f..697263b 100644
--- a/cpukit/score/inline/rtems/score/stack.inl
+++ b/cpukit/score/inline/rtems/score/stack.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/stack.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines from the Stack Handler
*
- * This file contains the static inline implementation of the inlined
- * routines from the Stack Handler.
+ * This file contains the static inline implementation of the inlined
+ * routines from the Stack Handler.
*/
/*
@@ -24,14 +26,15 @@
#include <rtems/score/basedefs.h> /* RTEMS_INLINE_ROUTINE */
/**
- * @addtogroup ScoreStack
- * @{
+ * @addtogroup ScoreStack
+ *
+ * @{
*/
/**
- * This routine initializes the_stack record to indicate that
- * size bytes of memory starting at starting_address have been
- * reserved for a stack.
+ * This routine initializes the_stack record to indicate that
+ * size bytes of memory starting at starting_address have been
+ * reserved for a stack.
*/
RTEMS_INLINE_ROUTINE void _Stack_Initialize (
Stack_Control *the_stack,
@@ -44,10 +47,10 @@ RTEMS_INLINE_ROUTINE void _Stack_Initialize (
}
/**
- * This function returns the minimum stack size configured
- * for this application.
+ * This function returns the minimum stack size configured
+ * for this application.
*
- * @return This method returns the minimum stack size;
+ * @return This method returns the minimum stack size;
*/
RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
{
@@ -55,12 +58,12 @@ RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
}
/**
- * This function returns true if size bytes is enough memory for
- * a valid stack area on this processor, and false otherwise.
+ * This function returns true if size bytes is enough memory for
+ * a valid stack area on this processor, and false otherwise.
*
- * @param[in] size is the stack size to check
+ * @param[in] size is the stack size to check
*
- * @return This method returns true if the stack is large enough.
+ * @return This method returns true if the stack is large enough.
*/
RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
size_t size
@@ -70,13 +73,13 @@ RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
}
/**
- * This function returns the appropriate stack size given the requested
- * size. If the requested size is below the minimum, then the minimum
- * configured stack size is returned.
+ * This function returns the appropriate stack size given the requested
+ * size. If the requested size is below the minimum, then the minimum
+ * configured stack size is returned.
*
- * @param[in] size is the stack size to check
+ * @param[in] size is the stack size to check
*
- * @return This method returns the appropriate stack size.
+ * @return This method returns the appropriate stack size.
*/
RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
size_t size
@@ -87,7 +90,7 @@ RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
return _Stack_Minimum();
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/states.inl b/cpukit/score/inline/rtems/score/states.inl
index f5d816a..7add9a3 100644
--- a/cpukit/score/inline/rtems/score/states.inl
+++ b/cpukit/score/inline/rtems/score/states.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/states.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with Thread State Information
*
- * This file contains the static inline implementation of the inlined
- * routines associated with thread state information.
+ * This file contains the static inline implementation of the inlined
+ * routines associated with thread state information.
*/
/*
@@ -24,18 +26,19 @@
#include <rtems/score/basedefs.h> /* RTEMS_INLINE_ROUTINE */
/**
- * @addtogroup ScoreStates
- * @{
+ * @addtogroup ScoreStates
+ *
+ * @{
*/
/**
- * This function sets the given states_to_set into the current_state
- * passed in. The result is returned to the user in current_state.
+ * This function sets the given states_to_set into the current_state
+ * passed in. The result is returned to the user in current_state.
*
- * @param[in] states_to_set is the state bits to set
- * @param[in] current_state is the state set to add them to
+ * @param[in] states_to_set is the state bits to set
+ * @param[in] current_state is the state set to add them to
*
- * @return This method returns the updated states value.
+ * @return This method returns the updated states value.
*/
RTEMS_INLINE_ROUTINE States_Control _States_Set (
States_Control states_to_set,
@@ -46,13 +49,13 @@ RTEMS_INLINE_ROUTINE States_Control _States_Set (
}
/**
- * This function clears the given states_to_clear into the current_state
- * passed in. The result is returned to the user in current_state.
+ * This function clears the given states_to_clear into the current_state
+ * passed in. The result is returned to the user in current_state.
*
- * @param[in] states_to_set is the state bits to clean
- * @param[in] current_state is the state set to remove them from
+ * @param[in] states_to_set is the state bits to clean
+ * @param[in] current_state is the state set to remove them from
*
- * @return This method returns the updated states value.
+ * @return This method returns the updated states value.
*/
RTEMS_INLINE_ROUTINE States_Control _States_Clear (
States_Control states_to_clear,
@@ -63,12 +66,12 @@ RTEMS_INLINE_ROUTINE States_Control _States_Clear (
}
/**
- * This function returns true if the_states indicates that the
- * state is READY, and false otherwise.
+ * This function returns true if the_states indicates that the
+ * state is READY, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_ready (
States_Control the_states
@@ -78,12 +81,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_ready (
}
/**
- * This function returns true if the DORMANT state is the ONLY state
- * set in the_states, and false otherwise.
+ * This function returns true if the DORMANT state is the ONLY state
+ * set in the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_only_dormant (
States_Control the_states
@@ -93,12 +96,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_only_dormant (
}
/**
- * This function returns true if the DORMANT state is set in
- * the_states, and false otherwise.
+ * This function returns true if the DORMANT state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_dormant (
States_Control the_states
@@ -108,12 +111,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_dormant (
}
/**
- * This function returns true if the SUSPENDED state is set in
- * the_states, and false otherwise.
+ * This function returns true if the SUSPENDED state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_suspended (
States_Control the_states
@@ -123,12 +126,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_suspended (
}
/**
- * This function returns true if the TRANSIENT state is set in
- * the_states, and false otherwise.
+ * This function returns true if the TRANSIENT state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_transient (
States_Control the_states
@@ -138,12 +141,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_transient (
}
/**
- * This function returns true if the DELAYING state is set in
- * the_states, and false otherwise.
+ * This function returns true if the DELAYING state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_delaying (
States_Control the_states
@@ -153,12 +156,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_delaying (
}
/**
- * This function returns true if the WAITING_FOR_BUFFER state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_BUFFER state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_buffer (
States_Control the_states
@@ -168,12 +171,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_buffer (
}
/**
- * This function returns true if the WAITING_FOR_SEGMENT state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_SEGMENT state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_segment (
States_Control the_states
@@ -183,12 +186,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_segment (
}
/**
- * This function returns true if the WAITING_FOR_MESSAGE state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_MESSAGE state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_message (
States_Control the_states
@@ -198,12 +201,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_message (
}
/**
- * This function returns true if the WAITING_FOR_EVENT state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_EVENT state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_event (
States_Control the_states
@@ -213,12 +216,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_event (
}
/**
- * This function returns true if the WAITING_FOR_SYSTEM_EVENT state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_SYSTEM_EVENT state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_system_event (
States_Control the_states
@@ -228,12 +231,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_system_event (
}
/**
- * This function returns true if the WAITING_FOR_MUTEX state
- * is set in the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_MUTEX state
+ * is set in the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_mutex (
States_Control the_states
@@ -243,12 +246,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_mutex (
}
/**
- * This function returns true if the WAITING_FOR_SEMAPHORE state
- * is set in the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_SEMAPHORE state
+ * is set in the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_semaphore (
States_Control the_states
@@ -258,12 +261,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_semaphore (
}
/**
- * This function returns true if the WAITING_FOR_TIME state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_TIME state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_time (
States_Control the_states
@@ -273,12 +276,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_time (
}
/**
- * This function returns true if the WAITING_FOR_TIME state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_TIME state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_rpc_reply (
States_Control the_states
@@ -288,12 +291,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_rpc_reply (
}
/**
- * This function returns true if the WAITING_FOR_PERIOD state is set in
- * the_states, and false otherwise.
+ * This function returns true if the WAITING_FOR_PERIOD state is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_period (
States_Control the_states
@@ -303,12 +306,12 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_period (
}
/**
- * This function returns true if the task's state is set in
- * way that allows it to be interrupted by a signal.
+ * This function returns true if the task's state is set in
+ * way that allows it to be interrupted by a signal.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_interruptible_by_signal (
States_Control the_states
@@ -318,13 +321,13 @@ RTEMS_INLINE_ROUTINE bool _States_Is_interruptible_by_signal (
}
/**
- * This function returns true if one of the states which indicates
- * that a task is blocked waiting for a local resource is set in
- * the_states, and false otherwise.
+ * This function returns true if one of the states which indicates
+ * that a task is blocked waiting for a local resource is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the desired state condition is set.
+ * @return This method returns true if the desired state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_locally_blocked (
@@ -335,14 +338,14 @@ RTEMS_INLINE_ROUTINE bool _States_Is_locally_blocked (
}
/**
- * This function returns true if one of the states which indicates
- * that a task is blocked waiting for a local resource is set in
- * the_states, and false otherwise.
+ * This function returns true if one of the states which indicates
+ * that a task is blocked waiting for a local resource is set in
+ * the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the state indicates that the
- * assocated thread is waiting on a thread queue.
+ * @return This method returns true if the state indicates that the
+ * assocated thread is waiting on a thread queue.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_waiting_on_thread_queue (
States_Control the_states
@@ -352,13 +355,13 @@ RTEMS_INLINE_ROUTINE bool _States_Is_waiting_on_thread_queue (
}
/**
- * This function returns true if one of the states which indicates
- * that a task is blocked is set in the_states, and false otherwise.
+ * This function returns true if one of the states which indicates
+ * that a task is blocked is set in the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
+ * @param[in] the_states is the task state set to test
*
- * @return This method returns true if the state indicates that the
- * assocated thread is blocked.
+ * @return This method returns true if the state indicates that the
+ * assocated thread is blocked.
*/
RTEMS_INLINE_ROUTINE bool _States_Is_blocked (
States_Control the_states
@@ -368,13 +371,13 @@ RTEMS_INLINE_ROUTINE bool _States_Is_blocked (
}
/**
- * This function returns true if any of the states in the mask
- * are set in the_states, and false otherwise.
+ * This function returns true if any of the states in the mask
+ * are set in the_states, and false otherwise.
*
- * @param[in] the_states is the task state set to test
- * @param[in] mask is the state bits to test for
+ * @param[in] the_states is the task state set to test
+ * @param[in] mask is the state bits to test for
*
- * @return This method returns true if the indicates state condition is set.
+ * @return This method returns true if the indicates state condition is set.
*/
RTEMS_INLINE_ROUTINE bool _States_Are_set (
States_Control the_states,
@@ -384,7 +387,7 @@ RTEMS_INLINE_ROUTINE bool _States_Are_set (
return ( (the_states & mask) != STATES_READY);
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/sysstate.inl b/cpukit/score/inline/rtems/score/sysstate.inl
index 02d2598..69d3724 100644
--- a/cpukit/score/inline/rtems/score/sysstate.inl
+++ b/cpukit/score/inline/rtems/score/sysstate.inl
@@ -1,9 +1,7 @@
-/**
+/**
* @file
*
- * @ingroup ScoreSysState
- *
- * @brief System State Handler API.
+ * @brief System State Handler API
*/
/*
@@ -23,7 +21,7 @@
#define _RTEMS_SCORE_SYSSTATE_INL
/**
- * @addtogroup ScoreSysState
+ * @addtogroup ScoreSysState
*
* @{
*/
@@ -34,7 +32,7 @@ RTEMS_INLINE_ROUTINE void _System_state_Set (
{
_System_state_Current = state;
}
-
+
RTEMS_INLINE_ROUTINE void _System_state_Handler_initialization (
#if defined(RTEMS_MULTIPROCESSING)
bool is_multiprocessing
@@ -96,7 +94,7 @@ RTEMS_INLINE_ROUTINE bool _System_state_Is_failed (
return (state == SYSTEM_STATE_FAILED);
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/thread.inl b/cpukit/score/inline/rtems/score/thread.inl
index 272c14f..8309f42 100644
--- a/cpukit/score/inline/rtems/score/thread.inl
+++ b/cpukit/score/inline/rtems/score/thread.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/thread.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines from the Thread Handler
*
- * This file contains the macro implementation of the inlined
- * routines from the Thread handler.
+ * This file contains the macro implementation of the inlined
+ * routines from the Thread handler.
*/
/*
@@ -25,8 +27,9 @@
#include <rtems/score/context.h>
/**
- * @addtogroup ScoreThread
- * @{
+ * @addtogroup ScoreThread
+ *
+ * @{
*/
#if defined(RTEMS_SMP)
@@ -37,8 +40,9 @@
#else
- /** @brief _Thread_Dispatch_in_critical_section
- *
+ /**
+ * @brief _Thread_Dispatch_in_critical_section
+ *
* This routine returns true if thread dispatch indicates
* that we are in a critical section.
*/
@@ -50,8 +54,9 @@
return true;
}
- /** @brief _Thread_Dispatch_get_disable_level
- *
+ /**
+ * @brief Get thread dispatch disable level.
+ *
* This routine returns value of the the thread dispatch level.
*/
RTEMS_INLINE_ROUTINE uint32_t _Thread_Dispatch_get_disable_level(void)
@@ -59,9 +64,10 @@
return _Thread_Dispatch_disable_level;
}
- /** @brief _Thread_Dispatch_set_disable_level
- *
- * This routine sets thread dispatch level to the
+ /**
+ * @brief Set thread dispatch disable level.
+ *
+ * This routine sets thread dispatch level to the
* value passed in.
*/
RTEMS_INLINE_ROUTINE uint32_t _Thread_Dispatch_set_disable_level(uint32_t value)
@@ -70,8 +76,9 @@
return value;
}
- /** @brief _Thread_Dispatch_increment_disable_level
- *
+ /**
+ * @brief Increase thread dispatch disable level.
+ *
* This rountine increments the thread dispatch level
*/
RTEMS_INLINE_ROUTINE uint32_t _Thread_Dispatch_increment_disable_level(void)
@@ -84,8 +91,9 @@
return level;
}
- /** @brief _Thread_Dispatch_decrement_disable_level
- *
+ /**
+ * @brief Decrease thread dispatch disable level.
+ *
* This routine decrements the thread dispatch level.
*/
RTEMS_INLINE_ROUTINE uint32_t _Thread_Dispatch_decrement_disable_level(void)
@@ -98,9 +106,10 @@
return level;
}
- /** @brief _Thread_Dispatch_initialization
- *
- * This routine initializes the thread dispatching subsystem.
+ /**
+ * @brief Thread dispatch initialization.
+ *
+ * This routine initializes the thread dispatching subsystem.
*/
RTEMS_INLINE_ROUTINE void _Thread_Dispatch_initialization( void )
{
@@ -110,9 +119,9 @@
#endif
/**
- * This routine halts multitasking and returns control to
- * the "thread" (i.e. the BSP) which initially invoked the
- * routine which initialized the system.
+ * This routine halts multitasking and returns control to
+ * the "thread" (i.e. the BSP) which initially invoked the
+ * routine which initialized the system.
*/
RTEMS_INLINE_ROUTINE void _Thread_Stop_multitasking( void )
@@ -140,8 +149,8 @@ RTEMS_INLINE_ROUTINE void _Thread_Stop_multitasking( void )
}
/**
- * This function returns true if the_thread is the currently executing
- * thread, and false otherwise.
+ * This function returns true if the_thread is the currently executing
+ * thread, and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_executing (
@@ -152,8 +161,8 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_executing (
}
/**
- * This function returns true if the_thread is the heir
- * thread, and false otherwise.
+ * This function returns true if the_thread is the heir
+ * thread, and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_heir (
@@ -164,8 +173,8 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_heir (
}
/**
- * This function returns true if the currently executing thread
- * is also the heir thread, and false otherwise.
+ * This function returns true if the currently executing thread
+ * is also the heir thread, and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_executing_also_the_heir( void )
@@ -174,9 +183,9 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_executing_also_the_heir( void )
}
/**
- * This routine clears any blocking state for the_thread. It performs
- * any necessary scheduling operations including the selection of
- * a new heir thread.
+ * This routine clears any blocking state for the_thread. It performs
+ * any necessary scheduling operations including the selection of
+ * a new heir thread.
*/
RTEMS_INLINE_ROUTINE void _Thread_Unblock (
@@ -187,8 +196,8 @@ RTEMS_INLINE_ROUTINE void _Thread_Unblock (
}
/**
- * This routine resets the current context of the calling thread
- * to that of its initial state.
+ * This routine resets the current context of the calling thread
+ * to that of its initial state.
*/
RTEMS_INLINE_ROUTINE void _Thread_Restart_self( void )
@@ -202,9 +211,9 @@ RTEMS_INLINE_ROUTINE void _Thread_Restart_self( void )
}
/**
- * This function returns true if the floating point context of
- * the_thread is currently loaded in the floating point unit, and
- * false otherwise.
+ * This function returns true if the floating point context of
+ * the_thread is currently loaded in the floating point unit, and
+ * false otherwise.
*/
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
@@ -217,8 +226,8 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_allocated_fp (
#endif
/**
- * This routine is invoked when the currently loaded floating
- * point context is now longer associated with an active thread.
+ * This routine is invoked when the currently loaded floating
+ * point context is now longer associated with an active thread.
*/
#if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
@@ -229,7 +238,7 @@ RTEMS_INLINE_ROUTINE void _Thread_Deallocate_fp( void )
#endif
/**
- * This routine prevents dispatching.
+ * This routine prevents dispatching.
*/
#if defined ( __THREAD_DO_NOT_INLINE_DISABLE_DISPATCH__ )
@@ -243,10 +252,10 @@ RTEMS_INLINE_ROUTINE void _Thread_Disable_dispatch( void )
#endif
/**
- * This routine allows dispatching to occur again. If this is
- * the outer most dispatching critical section, then a dispatching
- * operation will be performed and, if necessary, control of the
- * processor will be transferred to the heir thread.
+ * This routine allows dispatching to occur again. If this is
+ * the outer most dispatching critical section, then a dispatching
+ * operation will be performed and, if necessary, control of the
+ * processor will be transferred to the heir thread.
*/
#if defined ( __THREAD_DO_NOT_INLINE_ENABLE_DISPATCH__ )
@@ -262,9 +271,9 @@ RTEMS_INLINE_ROUTINE void _Thread_Disable_dispatch( void )
#endif
/**
- * This routine allows dispatching to occur again. However,
- * no dispatching operation is performed even if this is the outer
- * most dispatching critical section.
+ * This routine allows dispatching to occur again. However,
+ * no dispatching operation is performed even if this is the outer
+ * most dispatching critical section.
*/
RTEMS_INLINE_ROUTINE void _Thread_Unnest_dispatch( void )
@@ -274,8 +283,8 @@ RTEMS_INLINE_ROUTINE void _Thread_Unnest_dispatch( void )
}
/**
- * This function returns true if dispatching is disabled, and false
- * otherwise.
+ * This function returns true if dispatching is disabled, and false
+ * otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_dispatching_enabled( void )
@@ -284,8 +293,8 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_dispatching_enabled( void )
}
/**
- * This function returns true if dispatching is disabled, and false
- * otherwise.
+ * This function returns true if dispatching is disabled, and false
+ * otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_context_switch_necessary( void )
@@ -294,7 +303,7 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_context_switch_necessary( void )
}
/**
- * This function returns true if the_thread is NULL and false otherwise.
+ * This function returns true if the_thread is NULL and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_null (
@@ -304,9 +313,10 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_null (
return ( the_thread == NULL );
}
-/** @brief _Thread_Is_proxy_blocking
+/**
+ * @brief Is proxy blocking.
*
- * status which indicates that a proxy is blocking, and false otherwise.
+ * status which indicates that a proxy is blocking, and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Is_proxy_blocking (
uint32_t code
@@ -316,18 +326,18 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_proxy_blocking (
}
/**
- * This routine allocates an internal thread.
+ * This routine allocates an internal thread.
*/
-
+
RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Internal_allocate( void )
{
return (Thread_Control *) _Objects_Allocate( &_Thread_Internal_information );
}
-
+
/**
- * This routine frees an internal thread.
+ * This routine frees an internal thread.
*/
-
+
RTEMS_INLINE_ROUTINE void _Thread_Internal_free (
Thread_Control *the_task
)
@@ -336,18 +346,18 @@ RTEMS_INLINE_ROUTINE void _Thread_Internal_free (
}
/**
- * This routine returns the C library re-enterant pointer.
+ * This routine returns the C library re-enterant pointer.
*/
-
+
RTEMS_INLINE_ROUTINE struct _reent **_Thread_Get_libc_reent( void )
{
return _Thread_libc_reent;
}
/**
- * This routine set the C library re-enterant pointer.
+ * This routine set the C library re-enterant pointer.
*/
-
+
RTEMS_INLINE_ROUTINE void _Thread_Set_libc_reent (
struct _reent **libc_reent
)
@@ -356,13 +366,13 @@ RTEMS_INLINE_ROUTINE void _Thread_Set_libc_reent (
}
/**
- * This routine evaluates the current scheduling information for the
- * system and determines if a context switch is required. This
- * is usually called after changing an execution mode such as preemptability
- * for a thread.
+ * This routine evaluates the current scheduling information for the
+ * system and determines if a context switch is required. This
+ * is usually called after changing an execution mode such as preemptability
+ * for a thread.
*
- * @param[in] are_signals_pending specifies whether or not the API
- * level signals are pending and a dispatch is needed.
+ * @param[in] are_signals_pending specifies whether or not the API
+ * level signals are pending and a dispatch is needed.
*/
RTEMS_INLINE_ROUTINE bool _Thread_Evaluate_is_dispatch_needed(
bool are_signals_pending
@@ -381,7 +391,7 @@ RTEMS_INLINE_ROUTINE bool _Thread_Evaluate_is_dispatch_needed(
return false;
}
-/**@}*/
+/** @}*/
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/tod.inl b/cpukit/score/inline/rtems/score/tod.inl
index d8a8bb7..39849cb 100644
--- a/cpukit/score/inline/rtems/score/tod.inl
+++ b/cpukit/score/inline/rtems/score/tod.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/tod.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines from the Time of Day Handle
*
- * This file contains the static inline implementation of the inlined routines
- * from the Time of Day Handler.
+ * This file contains the static inline implementation of the inlined routines
+ * from the Time of Day Handler.
*/
/*
@@ -26,12 +28,13 @@
#include <rtems/score/isr.h>
/**
- * @addtogroup ScoreTOD
- * @{
+ * @addtogroup ScoreTOD
+ *
+ * @{
*/
/**
- * This routine deactivates updating of the current time of day.
+ * This routine deactivates updating of the current time of day.
*/
RTEMS_INLINE_ROUTINE void _TOD_Deactivate( void )
@@ -40,7 +43,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Deactivate( void )
}
/**
- * This routine activates updating of the current time of day.
+ * This routine activates updating of the current time of day.
*/
RTEMS_INLINE_ROUTINE void _TOD_Activate( void )
@@ -49,7 +52,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Activate( void )
}
/**
- * This routine returns a timeval based upon the internal timespec format TOD.
+ * This routine returns a timeval based upon the internal timespec format TOD.
*/
RTEMS_INLINE_ROUTINE void _TOD_Get_timeval(
@@ -64,7 +67,7 @@ RTEMS_INLINE_ROUTINE void _TOD_Get_timeval(
_Timestamp_To_timeval( snapshot_as_timestamp_ptr, time );
}
-/**@}*/
+/** @} */
#endif
/* end of include file */
diff --git a/cpukit/score/inline/rtems/score/tqdata.inl b/cpukit/score/inline/rtems/score/tqdata.inl
index aa7aaf4..b676eb0 100644
--- a/cpukit/score/inline/rtems/score/tqdata.inl
+++ b/cpukit/score/inline/rtems/score/tqdata.inl
@@ -1,8 +1,10 @@
-/**
- * @file rtems/score/tqdata.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Needed to Support the Thread Queue Data
*
- * This file contains the static inline implementation of the inlined
- * routines needed to support the Thread Queue Data.
+ * This file contains the static inline implementation of the inlined
+ * routines needed to support the Thread Queue Data.
*/
/*
@@ -22,13 +24,14 @@
#define _RTEMS_SCORE_TQDATA_INL
/**
- * @addtogroup ScoreThreadQ
- * @{
+ * @addtogroup ScoreThreadQ
+ *
+ * @{
*/
/**
- * This function returns the index of the priority chain on which
- * a thread of the_priority should be placed.
+ * This function returns the index of the priority chain on which
+ * a thread of the_priority should be placed.
*/
RTEMS_INLINE_ROUTINE uint32_t _Thread_queue_Header_number (
@@ -39,9 +42,9 @@ RTEMS_INLINE_ROUTINE uint32_t _Thread_queue_Header_number (
}
/**
- * This function returns true if the_priority indicates that the
- * enqueue search should start at the front of this priority
- * group chain, and false if the search should start at the rear.
+ * This function returns true if the_priority indicates that the
+ * enqueue search should start at the front of this priority
+ * group chain, and false if the search should start at the rear.
*/
RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_reverse_search (
@@ -52,10 +55,10 @@ RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_reverse_search (
}
/**
- * This routine is invoked to indicate that the specified thread queue is
- * entering a critical section.
+ * This routine is invoked to indicate that the specified thread queue is
+ * entering a critical section.
*/
-
+
RTEMS_INLINE_ROUTINE void _Thread_queue_Enter_critical_section (
Thread_queue_Control *the_thread_queue
)
@@ -63,9 +66,7 @@ RTEMS_INLINE_ROUTINE void _Thread_queue_Enter_critical_section (
the_thread_queue->sync_state = THREAD_BLOCKING_OPERATION_NOTHING_HAPPENED;
}
-/**
- * @}
- */
+/** @} */
#endif
/* end of include file */
More information about the vc
mailing list