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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Fri Apr  5 09:07:10 2019 +0200

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

Also renamed the group SuperCoreCopyright to RTEMSSuperCoreCopyright
Update #3706.

---

 cpukit/include/rtems/score/copyrt.h | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/cpukit/include/rtems/score/copyrt.h b/cpukit/include/rtems/score/copyrt.h
index 02f9501..c7b00b4 100644
--- a/cpukit/include/rtems/score/copyrt.h
+++ b/cpukit/include/rtems/score/copyrt.h
@@ -1,10 +1,12 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Copyright Notice for RTEMS
+ * @ingroup RTEMSSuperCoreCopyright
  *
- *  This include file contains the copyright notice for RTEMS
- *  which is included in every binary copy of the executive.
+ * @brief Copyright Notice for RTEMS
+ *
+ * This include file contains the copyright notice for RTEMS
+ * which is included in every binary copy of the executive.
  */
 
 /*
@@ -20,11 +22,15 @@
 #define _RTEMS_SCORE_COPYRT_H
 
 /**
- *  @defgroup SuperCoreCopyright RTEMS Copyright Notice
+ * @defgroup RTEMSSuperCoreCopyright RTEMS Copyright Notice
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Copyright Notice for RTEMS
  *
- *  @ingroup RTEMSScore
+ * @{
  */
-/**@{*/
+
 
 #ifdef __cplusplus
 extern "C" {
@@ -39,6 +45,7 @@ extern const char _Copyright_Notice[];
 }
 #endif
 
-/**@}*/
+/** @} */
+
 #endif
 /* end of include file */




More information about the vc mailing list