score: Simplify Chain_Node definition

Fix documentation.
This commit is contained in:
Sebastian Huber
2022-09-22 14:57:18 +02:00
parent acf1e5b266
commit 9ed7103c61

View File

@@ -61,17 +61,7 @@ extern "C" {
*/ */
/** /**
* @typedef Chain_Node * @brief This structure represents a chain node.
*
* This type definition promotes the name for the Chain Node used by
* all RTEMS code. It is a separate type definition because a forward
* reference is required to define it. See @ref Chain_Node_struct for
* detailed information.
*/
typedef struct Chain_Node_struct Chain_Node;
/**
* @struct Chain_Node_struct
* *
* This is used to manage each element (node) which is placed * This is used to manage each element (node) which is placed
* on a chain. * on a chain.
@@ -85,15 +75,15 @@ typedef struct Chain_Node_struct Chain_Node;
* so the user can cast the pointers back and forth. * so the user can cast the pointers back and forth.
* *
*/ */
struct Chain_Node_struct { typedef struct Chain_Node {
/** This points to the node after this one on this chain. */ /** This points to the node after this one on this chain. */
Chain_Node *next; struct Chain_Node *next;
/** This points to the node immediate prior to this one on this chain. */ /** This points to the node immediate prior to this one on this chain. */
Chain_Node *previous; struct Chain_Node *previous;
}; } Chain_Node;
/** /**
* @struct Chain_Control * @brief This union represents a chain control block.
* *
* This is used to manage a chain. A chain consists of a doubly * This is used to manage a chain. A chain consists of a doubly
* linked list of zero or more nodes. * linked list of zero or more nodes.