[rtems commit] doxygen: score: adjust doc in mppkt.h to doxygen guidelines

Sebastian Huber sebh at rtems.org
Mon May 13 05:52:28 UTC 2019


Module:    rtems
Branch:    master
Commit:    3da777eab762471b086b0a58a82d3da8e1565fdc
Changeset: http://git.rtems.org/rtems/commit/?id=3da777eab762471b086b0a58a82d3da8e1565fdc

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Wed Apr 10 08:06:14 2019 +0200

doxygen: score: adjust doc in mppkt.h to doxygen guidelines

Update #3706.

---

 cpukit/include/rtems/score/mppkt.h | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)

diff --git a/cpukit/include/rtems/score/mppkt.h b/cpukit/include/rtems/score/mppkt.h
index 12bda1b..1a00aa8 100644
--- a/cpukit/include/rtems/score/mppkt.h
+++ b/cpukit/include/rtems/score/mppkt.h
@@ -1,13 +1,15 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Specification for the Packet Handler
+ * @ingroup RTEMSScoreMPPacket
  *
- *  This package is the specification for the Packet Handler.
- *  This handler defines the basic packet and provides
- *  mechanisms to utilize packets based on this prefix.
- *  Packets are the fundamental basis for messages passed between
- *  nodes in an MP system.
+ * @brief Specification for the Packet Handler
+ *
+ * This package is the specification for the Packet Handler.
+ * This handler defines the basic packet and provides
+ * 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
 
 /**
- *  @defgroup RTEMSScoreMPPacket MP Packet Handler
+ * @defgroup RTEMSScoreMPPacket MP Packet Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief MP Packte Handler
  *
- *  @ingroup RTEMSScore
+ * This handler encapsulates the primary definition of MPCI packets.  This
+ * 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.
@@ -111,7 +116,7 @@ typedef struct {
 #define MP_PACKET_MINIMUN_HETERO_CONVERSION  \
   ( sizeof( MP_packet_Prefix ) / sizeof( uint32_t   ) )
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }



More information about the vc mailing list