forked from Imagelibrary/rtems
doxygen: score: adjust doc in mppkt.h to doxygen guidelines
Update #3706.
This commit is contained in:
committed by
Sebastian Huber
parent
57cd05cf58
commit
3da777eab7
@@ -1,13 +1,15 @@
|
|||||||
/**
|
/**
|
||||||
* @file
|
* @file
|
||||||
*
|
*
|
||||||
* @brief Specification for the Packet Handler
|
* @ingroup RTEMSScoreMPPacket
|
||||||
*
|
*
|
||||||
* This package is the specification for the Packet Handler.
|
* @brief Specification for the Packet Handler
|
||||||
* This handler defines the basic packet and provides
|
*
|
||||||
* mechanisms to utilize packets based on this prefix.
|
* This package is the specification for the Packet Handler.
|
||||||
* Packets are the fundamental basis for messages passed between
|
* This handler defines the basic packet and provides
|
||||||
* nodes in an MP system.
|
* mechanisms to utilize packets based on this prefix.
|
||||||
|
* Packets are the fundamental basis for messages passed between
|
||||||
|
* nodes in an MP system.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -31,15 +33,18 @@ extern "C" {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup RTEMSScoreMPPacket MP Packet Handler
|
* @defgroup RTEMSScoreMPPacket MP Packet Handler
|
||||||
*
|
*
|
||||||
* @ingroup RTEMSScore
|
* @ingroup RTEMSScore
|
||||||
*
|
*
|
||||||
* This handler encapsulates the primary definition of MPCI packets. This
|
* @brief MP Packte Handler
|
||||||
* handler defines the part of the packet that is common to all remote
|
*
|
||||||
* operations.
|
* This handler encapsulates the primary definition of MPCI packets. This
|
||||||
|
* handler defines the part of the packet that is common to all remote
|
||||||
|
* operations.
|
||||||
|
*
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
/**@{*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The following enumerated type defines the packet classes.
|
* The following enumerated type defines the packet classes.
|
||||||
@@ -111,7 +116,7 @@ typedef struct {
|
|||||||
#define MP_PACKET_MINIMUN_HETERO_CONVERSION \
|
#define MP_PACKET_MINIMUN_HETERO_CONVERSION \
|
||||||
( sizeof( MP_packet_Prefix ) / sizeof( uint32_t ) )
|
( sizeof( MP_packet_Prefix ) / sizeof( uint32_t ) )
|
||||||
|
|
||||||
/**@}*/
|
/** @} */
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user