summaryrefslogtreecommitdiffstats
path: root/cpukit/sapi/inline/rtems
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-08 07:13:41 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2013-01-08 07:13:41 -0600
commit27f071cd88134b995f562e7080ba9820f93d48df (patch)
tree1975c04f0412b6c400eb5ce26154080af7569d0a /cpukit/sapi/inline/rtems
parentlibcsupport: Doxygen Clean Up Task #1 (diff)
downloadrtems-27f071cd88134b995f562e7080ba9820f93d48df.tar.bz2
sapi: Doxygen Clean Up Task #1
Diffstat (limited to 'cpukit/sapi/inline/rtems')
-rw-r--r--cpukit/sapi/inline/rtems/cbs.inl86
-rw-r--r--cpukit/sapi/inline/rtems/chain.inl343
-rw-r--r--cpukit/sapi/inline/rtems/extension.inl2
-rw-r--r--cpukit/sapi/inline/rtems/rbtree.inl195
-rw-r--r--cpukit/sapi/inline/rtems/timespec.inl165
5 files changed, 403 insertions, 388 deletions
diff --git a/cpukit/sapi/inline/rtems/cbs.inl b/cpukit/sapi/inline/rtems/cbs.inl
index d4fb6a8d9d..01d7779318 100644
--- a/cpukit/sapi/inline/rtems/cbs.inl
+++ b/cpukit/sapi/inline/rtems/cbs.inl
@@ -1,8 +1,10 @@
/**
- * @file cbs.inl
- *
- * This include file contains all the constants and structures associated
- * with the CBS library.
+ * @file
+ *
+ * @brief Constants and Structures Associated with the CBS Library
+ *
+ * This include file contains all the constants and structures associated
+ * with the CBS library.
*
*/
@@ -22,11 +24,11 @@
#include <rtems/score/schedulercbs.h>
/**
- * @brief rtems cbs init
+ * @brief Initialize the CBS library.
*
- * Initializes the CBS library.
+ * Initializes the CBS library.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_initialize ( void )
{
@@ -34,11 +36,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_initialize ( void )
}
/**
- * @brief rtems cbs cleanup
+ * @brief Cleanup resources associated to the CBS Library
*
- * Cleanup resources associated to the CBS Library.
+ * Cleanup resources associated to the CBS Library.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_cleanup ( void )
{
@@ -46,11 +48,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_cleanup ( void )
}
/**
- * @brief rtems cbs create server
+ * @brief Create a new server with specified parameters.
*
- * Create a new server with specified parameters.
+ * Create a new server with specified parameters.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_create_server (
rtems_cbs_parameters *params,
@@ -66,11 +68,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_create_server (
}
/**
- * @brief rtems cbs attach thread
+ * @brief Attach a task to an already existing server.
*
- * Attach a task to an already existing server.
+ * Attach a task to an already existing server.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_attach_thread (
rtems_cbs_server_id server_id,
@@ -81,11 +83,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_attach_thread (
}
/**
- * @brief rtems cbs detach thread
+ * @brief Detach from the CBS server.
*
- * Detach from the CBS Server.
+ * Detach from the CBS Server.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_detach_thread (
rtems_cbs_server_id server_id,
@@ -96,11 +98,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_detach_thread (
}
/**
- * @brief rtems cbs destroy server
+ * @brief Detach all tasks from a server and destroy it.
*
- * Detach all tasks from a server and destroy it.
+ * Detach all tasks from a server and destroy it.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_destroy_server (
rtems_cbs_server_id server_id
@@ -110,12 +112,12 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_destroy_server (
}
/**
- * @brief rtems cbs get server id
+ * @brief Get CBS server id.
*
- * Get a thread server id, or RTEMS_CBS_E_NOT_FOUND if it is not
- * attached to any server.
+ * Get a thread server id, or RTEMS_CBS_E_NOT_FOUND if it is not
+ * attached to any server.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_get_server_id (
rtems_id task_id,
@@ -126,11 +128,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_get_server_id (
}
/**
- * @brief rtems cbs get parameters
+ * @brief Get CBS parameters.
*
- * Retrieve CBS scheduling parameters.
+ * Retrieve CBS scheduling parameters.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_get_parameters (
rtems_cbs_server_id server_id,
@@ -141,11 +143,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_get_parameters (
}
/**
- * @brief rtems cbs set parameters
+ * @brief Set CBS parameters.
*
- * Change CBS scheduling parameters.
+ * Change CBS scheduling parameters.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_set_parameters (
rtems_cbs_server_id server_id,
@@ -156,11 +158,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_set_parameters (
}
/**
- * @brief rtems cbs get execution time
+ * @brief Get the CBS get execution time.
*
- * Retrieve time info relative to the current server.
+ * Retrieve time info relative to the current server.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_get_execution_time (
rtems_cbs_server_id server_id,
@@ -172,11 +174,11 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_get_execution_time (
}
/**
- * @brief rtems cbs get remaining budget
+ * @brief Get the remaining CBS budget.
*
- * Retrieve remaining budget for the current server instance.
+ * Retrieve remaining budget for the current server instance.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_get_remaining_budget (
rtems_cbs_server_id server_id,
@@ -187,12 +189,12 @@ RTEMS_INLINE_ROUTINE int rtems_cbs_get_remaining_budget (
}
/**
- * @brief rtems cbs get approved budget
+ * @brief Get the approved CBS budget.
*
- * Retrieve the budget that has been approved for the subsequent
- * server instances.
+ * Retrieve the budget that has been approved for the subsequent
+ * server instances.
*
- * @return status code.
+ * @return status code.
*/
RTEMS_INLINE_ROUTINE int rtems_cbs_get_approved_budget (
rtems_cbs_server_id server_id,
diff --git a/cpukit/sapi/inline/rtems/chain.inl b/cpukit/sapi/inline/rtems/chain.inl
index a1bfc2f32e..bf98f98777 100644
--- a/cpukit/sapi/inline/rtems/chain.inl
+++ b/cpukit/sapi/inline/rtems/chain.inl
@@ -1,9 +1,7 @@
/**
* @file
*
- * @ingroup ClassicChains
- *
- * @brief Chain API.
+ * @brief Chain API
*/
/*
@@ -33,17 +31,17 @@
*/
/**
- * @brief Initialize a Chain Header
+ * @brief Initialize a chain Header.
*
- * This routine initializes @a the_chain structure to manage the
- * contiguous array of @a number_nodes nodes which starts at
- * @a starting_address. Each node is of @a node_size bytes.
+ * This routine initializes @a the_chain structure to manage the
+ * contiguous array of @a number_nodes nodes which starts at
+ * @a starting_address. Each node is of @a node_size bytes.
*
- * @param[in] the_chain specifies the chain to initialize
- * @param[in] starting_address is the starting address of the array
- * of elements
- * @param[in] number_nodes is the number of nodes that will be in the chain
- * @param[in] node_size is the size of each node
+ * @param[in] the_chain specifies the chain to initialize
+ * @param[in] starting_address is the starting address of the array
+ * of elements
+ * @param[in] number_nodes is the number of nodes that will be in the chain
+ * @param[in] node_size is the size of each node
*/
RTEMS_INLINE_ROUTINE void rtems_chain_initialize(
rtems_chain_control *the_chain,
@@ -56,11 +54,11 @@ RTEMS_INLINE_ROUTINE void rtems_chain_initialize(
}
/**
- * @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 rtems_chain_initialize_empty(
rtems_chain_control *the_chain
@@ -70,12 +68,12 @@ RTEMS_INLINE_ROUTINE void rtems_chain_initialize_empty(
}
/**
- * @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 rtems_chain_set_off_chain(
rtems_chain_node *node
@@ -85,14 +83,15 @@ RTEMS_INLINE_ROUTINE void rtems_chain_set_off_chain(
}
/**
- * @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 node is off chain.
+ * @retval false The node is not off chain.
*/
RTEMS_INLINE_ROUTINE bool rtems_chain_is_node_off_chain(
const rtems_chain_node *node
@@ -102,13 +101,14 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_node_off_chain(
}
/**
- * @brief Is the Chain Node Pointer NULL
- *
- * This function returns true if the_node is NULL and false otherwise.
+ * @brief Is the chain node pointer NULL.
*
- * @param[in] the_node is the node pointer to check.
+ * This function returns true if the_node is NULL and false otherwise.
*
- * @return This method returns true if the_node is NULL and false otherwise.
+ * @param[in] the_node is the node pointer to check.
+ *
+ * @retval true The chain node pointer is NULL.
+ * @retval false The chain node pointer is not NULL.
*/
RTEMS_INLINE_ROUTINE bool rtems_chain_is_null_node(
const rtems_chain_node *the_node
@@ -118,13 +118,13 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_null_node(
}
/**
- * @brief Return pointer to Chain Head
+ * @brief Return pointer to Chain Head
*
- * This function returns a pointer to the first node on the chain.
+ * This function returns a pointer to the first 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 node of the chain.
+ * @return This method returns the permanent node of the chain.
*/
RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_head(
rtems_chain_control *the_chain
@@ -133,13 +133,14 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_head(
return _Chain_Head( the_chain );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_head(
const rtems_chain_control *the_chain
@@ -149,13 +150,13 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_head(
}
/**
- * @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 rtems_chain_node *rtems_chain_tail(
rtems_chain_control *the_chain
@@ -164,13 +165,14 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_tail(
return _Chain_Tail( the_chain );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_tail(
const rtems_chain_control *the_chain
@@ -180,14 +182,14 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_tail(
}
/**
- * @brief Return pointer to Chain's First node after the permanent head.
+ * @brief Return pointer to Chain's First node after the permanent head.
*
- * 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 rtems_chain_node *rtems_chain_first(
rtems_chain_control *the_chain
@@ -196,14 +198,15 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_first(
return _Chain_First( the_chain );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_first(
const rtems_chain_control *the_chain
@@ -213,14 +216,14 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_first(
}
/**
- * @brief Return pointer to Chain's Last node before the permanent tail.
+ * @brief Return pointer to Chain's Last node before the permanent tail.
*
- * 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 rtems_chain_node *rtems_chain_last(
rtems_chain_control *the_chain
@@ -229,14 +232,15 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_last(
return _Chain_Last( the_chain );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_last(
const rtems_chain_control *the_chain
@@ -246,13 +250,13 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_last(
}
/**
- * @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 rtems_chain_node *rtems_chain_next(
rtems_chain_node *the_node
@@ -261,13 +265,14 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_next(
return _Chain_Next( the_node );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_next(
const rtems_chain_node *the_node
@@ -277,13 +282,13 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_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 rtems_chain_node *rtems_chain_previous(
rtems_chain_node *the_node
@@ -292,13 +297,14 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_previous(
return _Chain_Previous( the_node );
}
-/** @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 rtems_chain_node *rtems_chain_immutable_previous(
const rtems_chain_node *the_node
@@ -308,16 +314,16 @@ RTEMS_INLINE_ROUTINE const rtems_chain_node *rtems_chain_immutable_previous(
}
/**
- * @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 is equal to @a right.
+ * @retval false @a left is not equal to @a right
*/
RTEMS_INLINE_ROUTINE bool rtems_chain_are_nodes_equal(
const rtems_chain_node *left,
@@ -328,15 +334,15 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_are_nodes_equal(
}
/**
- * @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 The chain is empty.
+ * @retval false The chain is not empty.
*/
RTEMS_INLINE_ROUTINE bool rtems_chain_is_empty(
const rtems_chain_control *the_chain
@@ -346,16 +352,16 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_empty(
}
/**
- * @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 rtems_chain_is_first(
const rtems_chain_node *the_node
@@ -365,15 +371,15 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_first(
}
/**
- * @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 rtems_chain_is_last(
const rtems_chain_node *the_node
@@ -383,15 +389,15 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_last(
}
/**
- * @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.
+ * @retval true The chain has only one node.
+ * @retval false The chain has more than one nodes.
*/
RTEMS_INLINE_ROUTINE bool rtems_chain_has_only_one_node(
const rtems_chain_control *the_chain
@@ -401,16 +407,16 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_has_only_one_node(
}
/**
- * @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 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 rtems_chain_is_head(
const rtems_chain_control *the_chain,
@@ -421,13 +427,16 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_head(
}
/**
- * @brief Is this Node the Chail Tail
+ * @brief Is this node the chain tail.
*
- * This function returns true if the_node is the tail of the_chain and
- * false otherwise.
+ * This function returns true if the_node is the tail of 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 rtems_chain_is_tail(
const rtems_chain_control *the_chain,
@@ -438,13 +447,13 @@ RTEMS_INLINE_ROUTINE bool rtems_chain_is_tail(
}
/**
- * @brief Extract the specified node from a chain
+ * @brief Extract the specified node from a chain.
*
- * This routine extracts @a the_node from the chain on which it resides.
- * It disables interrupts to ensure the atomicity of the
- * extract operation.
+ * This routine extracts @a the_node from the chain on which it resides.
+ * It disables interrupts to ensure the atomicity of the
+ * extract operation.
*
- * @arg the_node specifies the node to extract
+ * @arg the_node specifies the node to extract
*/
RTEMS_INLINE_ROUTINE void rtems_chain_extract(
rtems_chain_node *the_node
@@ -454,12 +463,12 @@ RTEMS_INLINE_ROUTINE void rtems_chain_extract(
}
/**
- * @brief Extract the specified node from a chain (unprotected).
+ * @brief Extract the specified node from a chain (unprotected).
*
- * This routine extracts @a the_node from the chain on which it resides.
+ * This routine extracts @a the_node from the chain on which it resides.
*
- * @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 rtems_chain_extract_unprotected(
rtems_chain_node *the_node
@@ -469,16 +478,16 @@ RTEMS_INLINE_ROUTINE void rtems_chain_extract_unprotected(
}
/**
- * @brief Obtain the first node on a chain
+ * @brief Obtain the first node on a chain.
*
- * This function removes the first node from @a the_chain and returns
- * a pointer to that node. If @a the_chain is empty, then NULL is returned.
+ * This function removes the first node from @a the_chain and returns
+ * a pointer to that node. If @a the_chain is empty, then NULL is returned.
*
- * @return This method returns a pointer a node. If a node was removed,
- * then a pointer to that node is returned. If @a the_chain was
- * empty, then NULL is returned.
+ * @return This method returns a pointer a node. If a node was removed,
+ * then a pointer to that node is returned. If @a the_chain was
+ * empty, then NULL is returned.
*
- * @note It disables interrupts to ensure the atomicity of the get operation.
+ * NOTE: It disables interrupts to ensure the atomicity of the get operation.
*/
RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_get(
rtems_chain_control *the_chain
@@ -498,13 +507,13 @@ RTEMS_INLINE_ROUTINE rtems_chain_node *rtems_chain_get_unprotected(
}
/**
- * @brief Insert a node on a chain
+ * @brief Insert a node on a chain
*
- * This routine inserts @a the_node on a chain immediately following
- * @a after_node.
+ * This routine inserts @a the_node on a chain immediately following
+ * @a after_node.
*
- * @note It disables interrupts to ensure the atomicity
- * of the extract operation.
+ * NOTE: It disables interrupts to ensure the atomicity
+ * of the extract operation.
*/
RTEMS_INLINE_ROUTINE void rtems_chain_insert(
rtems_chain_node *after_node,
@@ -526,12 +535,12 @@ RTEMS_INLINE_ROUTINE void rtems_chain_insert_unprotected(
}
/**
- * @brief Append a node on the end of a chain
+ * @brief Append a node on the end of a chain.
*
- * This routine appends @a the_node onto the end of @a the_chain.
+ * This routine appends @a the_node onto the end of @a the_chain.
*
- * @note It disables interrupts to ensure the atomicity of the
- * append operation.
+ * NOTE: It disables interrupts to ensure the atomicity of the
+ * append operation.
*/
RTEMS_INLINE_ROUTINE void rtems_chain_append(
rtems_chain_control *the_chain,
@@ -542,12 +551,12 @@ RTEMS_INLINE_ROUTINE void rtems_chain_append(
}
/**
- * @brief Append a node on the end of a chain (unprotected)
+ * @brief Append a node on the end of a chain (unprotected).
*
- * This routine appends @a the_node onto the end of @a the_chain.
+ * This routine appends @a the_node onto the end of @a the_chain.
*
- * @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 rtems_chain_append_unprotected(
rtems_chain_control *the_chain,
@@ -557,15 +566,16 @@ RTEMS_INLINE_ROUTINE void rtems_chain_append_unprotected(
_Chain_Append_unprotected( the_chain, the_node );
}
-/** @brief Prepend a Node
+/**
+ * @brief Prepend a node.
*
- * 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 rtems_chain_prepend(
rtems_chain_control *the_chain,
@@ -575,15 +585,16 @@ RTEMS_INLINE_ROUTINE void rtems_chain_prepend(
_Chain_Prepend( the_chain, the_node );
}
-/** @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 rtems_chain_prepend_unprotected(
rtems_chain_control *the_chain,
diff --git a/cpukit/sapi/inline/rtems/extension.inl b/cpukit/sapi/inline/rtems/extension.inl
index 968b62b58e..0d0cfc2320 100644
--- a/cpukit/sapi/inline/rtems/extension.inl
+++ b/cpukit/sapi/inline/rtems/extension.inl
@@ -3,7 +3,7 @@
*
* @ingroup ClassicUserExtensions
*
- * @brief User Extensions API.
+ * @brief User Extensions API
*/
/*
diff --git a/cpukit/sapi/inline/rtems/rbtree.inl b/cpukit/sapi/inline/rtems/rbtree.inl
index f7983ad10d..20e7aa3890 100644
--- a/cpukit/sapi/inline/rtems/rbtree.inl
+++ b/cpukit/sapi/inline/rtems/rbtree.inl
@@ -1,18 +1,20 @@
/**
- * @file rtems/rbtree.inl
+ * @file
+ *
+ * @brief Constants and Structures Associated with the RBTree API in RTEMS
*
- * This include file contains all the constants and structures associated
- * with the RBTree API in RTEMS. The rbtree is a Red Black Tree that
- * is part of the Super Core. This is the published interface to that
- * code.
+ * This include file contains all the constants and structures associated
+ * with the RBTree API in RTEMS. The rbtree is a Red Black Tree that
+ * is part of the Super Core. This is the published interface to that
+ * code.
*/
/*
- * Copyright (c) 2010-2012 Gedare Bloom.
+ * Copyright (c) 2010-2012 Gedare Bloom.
*
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
*/
#ifndef _RTEMS_RBTREE_H
@@ -25,11 +27,11 @@
#include <rtems/score/rbtree.inl>
/**
- * @brief Initialize a RBTree Header
+ * @brief Initialize a RBTree header.
*
- * This routine initializes @a the_rbtree structure to manage the
- * contiguous array of @a number_nodes nodes which starts at
- * @a starting_address. Each node is of @a node_size bytes.
+ * This routine initializes @a the_rbtree structure to manage the
+ * contiguous array of @a number_nodes nodes which starts at
+ * @a starting_address. Each node is of @a node_size bytes.
*/
RTEMS_INLINE_ROUTINE void rtems_rbtree_initialize(
rtems_rbtree_control *the_rbtree,
@@ -45,9 +47,9 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_initialize(
}
/**
- * @brief Initialize this RBTree as Empty
+ * @brief Initialize this RBTree as Empty
*
- * This routine initializes @a the_rbtree to contain zero nodes.
+ * This routine initializes @a the_rbtree to contain zero nodes.
*/
RTEMS_INLINE_ROUTINE void rtems_rbtree_initialize_empty(
rtems_rbtree_control *the_rbtree,
@@ -59,10 +61,10 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_initialize_empty(
}
/**
- * @brief Set off rbtree
+ * @brief Set off RBtree.
*
- * This function sets the next and previous fields of the @a node to NULL
- * indicating the @a node is not part of any rbtree.
+ * This function sets the next and previous fields of the @a node to NULL
+ * indicating the @a node is not part of any rbtree.
*/
RTEMS_INLINE_ROUTINE void rtems_rbtree_set_off_rbtree(
rtems_rbtree_node *node
@@ -72,10 +74,10 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_set_off_rbtree(
}
/**
- * @brief Is the Node off RBTree
+ * @brief Is the Node off RBTree.
*
- * This function returns true if the @a node is not on a rbtree. A @a node is
- * off rbtree if the next and previous fields are set to NULL.
+ * This function returns true if the @a node is not on a rbtree. A @a node is
+ * off rbtree if the next and previous fields are set to NULL.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_node_off_rbtree(
const rtems_rbtree_node *node
@@ -85,9 +87,9 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_node_off_rbtree(
}
/**
- * @brief Is the RBTree Node Pointer NULL
+ * @brief Is the RBTree Node Pointer NULL.
*
- * This function returns true if @a the_node is NULL and false otherwise.
+ * This function returns true if @a the_node is NULL and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_null_node(
const rtems_rbtree_node *the_node
@@ -97,9 +99,9 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_null_node(
}
/**
- * @brief Return pointer to RBTree Root
+ * @brief Return pointer to RBTree root.
*
- * This function returns a pointer to the root node of @a the_rbtree.
+ * This function returns a pointer to the root node of @a the_rbtree.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_root(
const rtems_rbtree_control *the_rbtree
@@ -109,9 +111,9 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_root(
}
/**
- * @brief Return pointer to RBTree Minimum
+ * @brief Return pointer to RBTree Minimum
*
- * This function returns a pointer to the minimum node of @a the_rbtree.
+ * This function returns a pointer to the minimum node of @a the_rbtree.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_min(
const rtems_rbtree_control *the_rbtree
@@ -121,9 +123,9 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_min(
}
/**
- * @brief Return pointer to RBTree Maximum
+ * @brief Return pointer to RBTree maximum.
*
- * This function returns a pointer to the maximum node of @a the_rbtree.
+ * This function returns a pointer to the maximum node of @a the_rbtree.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_max(
const rtems_rbtree_control *the_rbtree
@@ -133,9 +135,9 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_max(
}
/**
- * @brief Return pointer to the left child node from this node
+ * @brief Return pointer to the left child node from this node.
*
- * This function returns a pointer to the left child node of @a the_node.
+ * This function returns a pointer to the left child node of @a the_node.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_left(
const rtems_rbtree_node *the_node
@@ -145,9 +147,9 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_left(
}
/**
- * @brief Return pointer to the right child node from this node
+ * @brief Return pointer to the right child node from this node.
*
- * This function returns a pointer to the right child node of @a the_node.
+ * This function returns a pointer to the right child node of @a the_node.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_right(
const rtems_rbtree_node *the_node
@@ -157,9 +159,9 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_right(
}
/**
- * @brief Return pointer to the parent child node from this node
+ * @brief Return pointer to the parent child node from this node.
*
- * This function returns a pointer to the parent node of @a the_node.
+ * This function returns a pointer to the parent node of @a the_node.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_parent(
const rtems_rbtree_node *the_node
@@ -169,10 +171,10 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_parent(
}
/**
- * @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.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_are_nodes_equal(
const rtems_rbtree_node *left,
@@ -183,10 +185,10 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_are_nodes_equal(
}
/**
- * @brief Is the RBTree Empty
+ * @brief Is the RBTree empty.
*
- * This function returns true if there a no nodes on @a the_rbtree and
- * false otherwise.
+ * This function returns true if there a no nodes on @a the_rbtree and
+ * false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_empty(
const rtems_rbtree_control *the_rbtree
@@ -196,10 +198,10 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_empty(
}
/**
- * @brief Is this the Minimum Node on the RBTree
+ * @brief Is this the minimum node on the RBTree.
*
- * This function returns true if @a the_node is the min node on @a the_rbtree
- * and false otherwise.
+ * This function returns true if @a the_node is the min node on @a the_rbtree
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_min(
const rtems_rbtree_control *the_rbtree,
@@ -210,10 +212,10 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_min(
}
/**
- * @brief Is this the Maximum Node on the RBTree
+ * @brief Is this the maximum node on the RBTree.
*
- * This function returns true if @a the_node is the max node on @a the_rbtree
- * and false otherwise.
+ * This function returns true if @a the_node is the max node on @a the_rbtree
+ * and false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_max(
const rtems_rbtree_control *the_rbtree,
@@ -225,10 +227,10 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_max(
/**
- * @brief Does this RBTree have only One Node
+ * @brief Does this RBTree have only one node.
*
- * This function returns true if there is only one node on @a the_rbtree and
- * false otherwise.
+ * This function returns true if there is only one node on @a the_rbtree and
+ * false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_has_only_one_node(
const rtems_rbtree_control *the_rbtree
@@ -238,10 +240,10 @@ RTEMS_INLINE_ROUTINE bool rtems_rbtree_has_only_one_node(
}
/**
- * @brief Is this Node the RBTree Root
+ * @brief Is this node the RBTree root.
*
- * This function returns true if @a the_node is the root of @a the_rbtree and
- * false otherwise.
+ * This function returns true if @a the_node is the root of @a the_rbtree and
+ * false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_root(
const rtems_rbtree_control *the_rbtree,
@@ -262,14 +264,14 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_find_unprotected(
return _RBTree_Find_unprotected( the_rbtree, the_node );
}
-/** @brief Find the node with given key in the tree
+/** @brief Find the node with given key in the tree.
*
- * This function returns a pointer to the node having key equal to the key
- * of @a the_node if it exists within @a the_rbtree, and NULL if not.
- * @a the_node has to be made up before a search.
+ * This function returns a pointer to the node having key equal to the key
+ * of @a the_node if it exists within @a the_rbtree, and NULL if not.
+ * @a the_node has to be made up before a search.
*
- * @note If the tree is not unique and contains duplicate keys, the set
- * of duplicate keys acts as FIFO.
+ * @note If the tree is not unique and contains duplicate keys, the set
+ * of duplicate keys acts as FIFO.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_find(
const rtems_rbtree_control *the_rbtree,
@@ -331,10 +333,10 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_extract_unprotected(
}
/**
- * @brief Extract the specified node from a rbtree
+ * @brief Extract the specified node from a rbtree.
*
- * This routine extracts @a the_node from @a the_rbtree on which it resides.
- * It disables interrupts to ensure the atomicity of the extract operation.
+ * This routine extracts @a the_node from @a the_rbtree on which it resides.
+ * It disables interrupts to ensure the atomicity of the extract operation.
*/
RTEMS_INLINE_ROUTINE void rtems_rbtree_extract(
rtems_rbtree_control *the_rbtree,
@@ -345,10 +347,10 @@ RTEMS_INLINE_ROUTINE void rtems_rbtree_extract(
}
/**
- * @brief Obtain the min node on a rbtree
+ * @brief Obtain the min node on a rbtree.
*
- * This function removes the min node from @a the_rbtree and returns
- * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
+ * This function removes the min node from @a the_rbtree and returns
+ * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min_unprotected(
@@ -359,11 +361,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min_unprotected(
}
/**
- * @brief Obtain the min node on a rbtree
+ * @brief Obtain the min node on a rbtree.
*
- * This function removes the min node from @a the_rbtree and returns
- * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
- * It disables interrupts to ensure the atomicity of the get operation.
+ * This function removes the min node from @a the_rbtree and returns
+ * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
+ * It disables interrupts to ensure the atomicity of the get operation.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min(
rtems_rbtree_control *the_rbtree
@@ -373,10 +375,10 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min(
}
/**
- * @brief Obtain the max node on a rbtree
+ * @brief Obtain the max node on a rbtree.
*
- * This function removes the max node from @a the_rbtree and returns
- * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
+ * This function removes the max node from @a the_rbtree and returns
+ * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max_unprotected(
@@ -387,11 +389,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max_unprotected(
}
/**
- * @brief Obtain the max node on a rbtree
+ * @brief Obtain the max node on a rbtree.
*
- * This function removes the max node from @a the_rbtree and returns
- * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
- * It disables interrupts to ensure the atomicity of the get operation.
+ * This function removes the max node from @a the_rbtree and returns
+ * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.
+ * It disables interrupts to ensure the atomicity of the get operation.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max(
rtems_rbtree_control *the_rbtree
@@ -401,11 +403,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max(
}
/**
- * @brief Peek at the min node on a rbtree
+ * @brief Peek at the min node on a rbtree.
*
- * This function returns a pointer to the min node from @a the_rbtree
- * without changing the tree. If @a the_rbtree is empty,
- * then NULL is returned.
+ * This function returns a pointer to the min node from @a the_rbtree
+ * without changing the tree. If @a the_rbtree is empty,
+ * then NULL is returned.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_peek_min(
const rtems_rbtree_control *the_rbtree
@@ -415,11 +417,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_peek_min(
}
/**
- * @brief Peek at the max node on a rbtree
+ * @brief Peek at the max node on a rbtree.
*
- * This function returns a pointer to the max node from @a the_rbtree
- * without changing the tree. If @a the_rbtree is empty,
- * then NULL is returned.
+ * This function returns a pointer to the max node from @a the_rbtree
+ * without changing the tree. If @a the_rbtree is empty,
+ * then NULL is returned.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_peek_max(
const rtems_rbtree_control *the_rbtree
@@ -439,11 +441,11 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_control *rtems_rbtree_find_header_unprotected(
}
/**
- * @brief Find the control header of the tree containing a given node.
+ * @brief Find the control header of the tree containing a given node.
*
- * This routine finds the rtems_rbtree_control structure of the tree
- * containing @a the_node.
- * It disables interrupts to ensure the atomicity of the find operation.
+ * This routine finds the rtems_rbtree_control structure of the tree
+ * containing @a the_node.
+ * It disables interrupts to ensure the atomicity of the find operation.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_control *rtems_rbtree_find_header(
rtems_rbtree_node *the_node
@@ -464,15 +466,15 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert_unprotected(
}
/**
- * @brief Insert a node on a rbtree
+ * @brief Insert a node on a rbtree.
*
- * This routine inserts @a the_node on @a the_rbtree.
- * It disables interrupts to ensure the atomicity of the insert operation.
+ * This routine inserts @a the_node on @a the_rbtree.
+ * It disables interrupts to ensure the atomicity of the insert operation.
*
- * @retval 0 Successfully inserted.
- * @retval -1 NULL @a the_node.
- * @retval RBTree_Node* if one with equal key to the key of @a the_node exists
- * in an unique @a the_rbtree.
+ * @retval 0 Successfully inserted.
+ * @retval -1 NULL @a the_node.
+ * @retval RBTree_Node* if one with equal key to the key of @a the_node exists
+ * in an unique @a the_rbtree.
*/
RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert(
rtems_rbtree_control *the_rbtree,
@@ -482,7 +484,8 @@ RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert(
return _RBTree_Insert( the_rbtree, the_node );
}
-/** @brief Determines whether the tree is unique
+/**
+ * @brief Determines whether the tree is unique.
*/
RTEMS_INLINE_ROUTINE bool rtems_rbtree_is_unique(
const rtems_rbtree_control *the_rbtree
diff --git a/cpukit/sapi/inline/rtems/timespec.inl b/cpukit/sapi/inline/rtems/timespec.inl
index 9874b65153..659c39fd35 100644
--- a/cpukit/sapi/inline/rtems/timespec.inl
+++ b/cpukit/sapi/inline/rtems/timespec.inl
@@ -1,9 +1,7 @@
/**
- * @file rtems/sapi/timespec.inl
+ * @file
*
- * @ingroup
- *
- * @brief Timespec API.
+ * @brief Timespec API
*/
/*
@@ -31,14 +29,14 @@
*/
/**
- * @brief Is Timespec Valid
+ * @brief Is timespec valid
*
- * This method determines the validity of a timespec.
+ * This method determines the validity of a timespec.
*
- * @param[in] time is the timespec instance to validate.
+ * @param[in] time is the timespec instance to validate.
*
- * @return This method returns true if @a time is valid and
- * false otherwise.
+ * @retval true The timespec is valid.
+ * @retval false The timespec is not valid.
*/
RTEMS_INLINE_ROUTINE bool rtems_timespec_is_valid(
const struct timespec *time
@@ -48,15 +46,16 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_is_valid(
}
/**
- * @brief Timespec Less Than Operator
+ * @brief Timespec less than operator.
*
- * This method is the less than operator for timespecs.
+ * This method is the less than operator for timespecs.
*
- * @param[in] lhs is the left hand side timespec
- * @param[in] rhs is the right hand side timespec
+ * @param[in] lhs is the left hand side timespec
+ * @param[in] rhs is the right hand side timespec
*
- * @return This method returns true if @a lhs is less than the @a rhs and
- * false otherwise.
+ * @retval true @a lhs is less than @a rhr.
+ * @retval false @a lhs is not less than @a rhr.
+ *
*/
RTEMS_INLINE_ROUTINE bool rtems_timespec_less_than(
const struct timespec *lhs,
@@ -67,15 +66,15 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_less_than(
}
/**
- * @brief Add to a Timespec
+ * @brief Add to a timespec.
*
- * This routine adds two timespecs. The second argument is added
- * to the first.
+ * This routine adds two timespecs. The second argument is added
+ * to the first.
*
- * @param[in] time is the base time to be added to
- * @param[in] add is the timespec to add to the first argument
+ * @param[in] time is the base time to be added to
+ * @param[in] add is the timespec to add to the first argument
*
- * @return This method returns the number of seconds @a time increased by.
+ * @return This method returns the number of seconds @a time increased by.
*/
RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_add_to(
struct timespec *time,
@@ -86,14 +85,14 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_add_to(
}
/**
- * @brief Convert Timespec to Number of Ticks
+ * @brief Convert timespec to number of ticks.
*
- * This routine convert the @a time timespec to the corresponding number
- * of clock ticks.
+ * This routine convert the @a time timespec to the corresponding number
+ * of clock ticks.
*
- * @param[in] time is the time to be converted
+ * @param[in] time is the time to be converted
*
- * @return This method returns the number of ticks computed.
+ * @return This method returns the number of ticks computed.
*/
RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_to_ticks(
const struct timespec *time
@@ -103,13 +102,13 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_to_ticks(
}
/**
- * @brief Convert Ticks to Timespec
+ * @brief Convert ticks to timespec.
*
- * This routine converts the @a ticks value to the corresponding
- * timespec format @a time.
+ * This routine converts the @a ticks value to the corresponding
+ * timespec format @a time.
*
- * @param[in] time is the timespec format time result
- * @param[in] ticks is the number of ticks to convert
+ * @param[in] time is the timespec format time result
+ * @param[in] ticks is the number of ticks to convert
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_from_ticks(
@@ -121,16 +120,16 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_from_ticks(
}
/**
- * @brief Subtract Two Timespec
+ * @brief Subtract two timespec.
*
- * This routine subtracts two timespecs. @a result is set to
- * @a end - @a start.
+ * This routine subtracts two timespecs. @a result is set to
+ * @a end - @a start.
*
- * @param[in] start is the starting time
- * @param[in] end is the ending time
- * @param[in] result is the difference between starting and ending time.
+ * @param[in] start is the starting time
+ * @param[in] end is the ending time
+ * @param[in] result is the difference between starting and ending time.
*
- * @return This method fills in @a result.
+ * @return This method fills in @a result.
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_subtract(
const struct timespec *start,
@@ -142,17 +141,17 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_subtract(
}
/**
- * @brief Divide Timespec By Integer
+ * @brief Divide timespec by integer.
*
- * This routine divides a timespec by an integer value. The expected
- * use is to assist in benchmark calculations where you typically
- * divide a duration by a number of iterations.
+ * This routine divides a timespec by an integer value. The expected
+ * use is to assist in benchmark calculations where you typically
+ * divide a duration by a number of iterations.
*
- * @param[in] time is the total
- * @param[in] iterations is the number of iterations
- * @param[in] result is the average time.
+ * @param[in] time is the total
+ * @param[in] iterations is the number of iterations
+ * @param[in] result is the average time.
*
- * @return This method fills in @a result.
+ * @return This method fills in @a result.
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_divide_by_integer(
const struct timespec *time,
@@ -164,17 +163,17 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_divide_by_integer(
}
/**
- * @brief Divide Timespec
+ * @brief Divide timespec.
*
- * This routine divides a timespec by another timespec. The
- * intended use is for calculating percentages to three decimal points.
+ * This routine divides a timespec by another timespec. The
+ * intended use is for calculating percentages to three decimal points.
*
- * @param[in] lhs is the left hand number
- * @param[in] rhs is the right hand number
- * @param[in] ival_percentage is the integer portion of the average
- * @param[in] fval_percentage is the thousandths of percentage
+ * @param[in] lhs is the left hand number
+ * @param[in] rhs is the right hand number
+ * @param[in] ival_percentage is the integer portion of the average
+ * @param[in] fval_percentage is the thousandths of percentage
*
- * @return This method fills in @a result.
+ * @return This method fills in @a result.
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_divide(
const struct timespec *lhs,
@@ -187,14 +186,14 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_divide(
}
/**
- * @brief Set Timespec to Seconds Nanosecond
+ * @brief Set timespec to seconds nanosecond.
*
- * This method sets the timespec to the specified seconds and nanoseconds
- * value.
+ * This method sets the timespec to the specified seconds and nanoseconds
+ * value.
*
- * @param[in] _time points to the timespec instance to validate.
- * @param[in] _seconds is the seconds portion of the timespec
- * @param[in] _nanoseconds is the nanoseconds portion of the timespec
+ * @param[in] _time points to the timespec instance to validate.
+ * @param[in] _seconds is the seconds portion of the timespec
+ * @param[in] _nanoseconds is the nanoseconds portion of the timespec
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_set(
struct timespec *_time,
@@ -206,12 +205,12 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_set(
}
/**
- * @brief Zero Timespec
+ * @brief Zero timespec.
*
- * This method sets the timespec to zero.
- * value.
+ * This method sets the timespec to zero.
+ * value.
*
- * @param[in] _time points to the timespec instance to zero.
+ * @param[in] _time points to the timespec instance to zero.
*/
RTEMS_INLINE_ROUTINE void rtems_timespec_zero(
struct timespec *_time
@@ -221,13 +220,13 @@ RTEMS_INLINE_ROUTINE void rtems_timespec_zero(
}
/**
- * @brief Get Seconds Portion of Timespec
+ * @brief Get seconds portion of timespec.
*
- * This method returns the seconds portion of the specified timespec
+ * This method returns the seconds portion of the specified timespec
*
- * @param[in] _time points to the timespec
+ * @param[in] _time points to the timespec
*
- * @return The seconds portion of @a _time.
+ * @return The seconds portion of @a _time.
*/
RTEMS_INLINE_ROUTINE time_t rtems_timespec_get_seconds(
struct timespec *_time
@@ -237,13 +236,13 @@ RTEMS_INLINE_ROUTINE time_t rtems_timespec_get_seconds(
}
/**
- * @brief Get Nanoseconds Portion of Timespec
+ * @brief Get nanoseconds portion of timespec.
*
- * This method returns the nanoseconds portion of the specified timespec
+ * This method returns the nanoseconds portion of the specified timespec
*
- * @param[in] _time points to the timespec
+ * @param[in] _time points to the timespec
*
- * @return The nanoseconds portion of @a _time.
+ * @return The nanoseconds portion of @a _time.
*/
RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_get_nanoseconds(
struct timespec *_time
@@ -254,15 +253,15 @@ RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_get_nanoseconds(
/**
- * @brief Timespec Greater Than Operator
+ * @brief Timespec greater than operator.
*
- * This method is the greater than operator for timespecs.
+ * This method is the greater than operator for timespecs.
*
- * @param[in] lhs is the left hand side timespec
- * @param[in] rhs is the right hand side timespec
+ * @param[in] lhs is the left hand side timespec
+ * @param[in] rhs is the right hand side timespec
*
- * @return This method returns true if @a lhs is greater than the @a rhs and
- * false otherwise.
+ * @retval true @a lhs is greater than @a rhr.
+ * @retval false @a lhs is not greater than @a rhr.
*/
RTEMS_INLINE_ROUTINE bool rtems_timespec_greater_than(
const struct timespec *_lhs,
@@ -274,13 +273,13 @@ RTEMS_INLINE_ROUTINE bool rtems_timespec_greater_than(
/**
* @brief Timespec equal to Operator
*
- * This method is the is equal to than operator for timespecs.
+ * This method is the is equal to than operator for timespecs.
*
- * @param[in] lhs is the left hand side timespec
- * @param[in] rhs is the right hand side timespec
+ * @param[in] lhs is the left hand side timespec
+ * @param[in] rhs is the right hand side timespec
*
- * @return This method returns true if @a lhs is equal to @a rhs and
- * false otherwise.
+ * @retval true @a lhs is equal to @a rhr.
+ * @retval false @a lhs is not equal to @a rhr.
*/
RTEMS_INLINE_ROUTINE bool rtems_timespec_equal_to(
const struct timespec *lhs,