[rtems commit] doxygen: score: added dox in assert.h according to doxygen guidelines

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


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

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

doxygen: score: added dox in assert.h according to doxygen guidelines

Update #3706.

---

 cpukit/include/rtems/score/assert.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/cpukit/include/rtems/score/assert.h b/cpukit/include/rtems/score/assert.h
index d443283..6c68d9d 100644
--- a/cpukit/include/rtems/score/assert.h
+++ b/cpukit/include/rtems/score/assert.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreAssert
+ *
+ * @brief Information for the Assert Handler
+ */
+
 /*
  * Copyright (c) 2013-2014 embedded brains GmbH.  All rights reserved.
  *
@@ -17,6 +25,16 @@
 
 #include <rtems/score/basedefs.h>
 
+/**
+ * @defgroup RTEMSScoreAssert Assert Handler
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief Support for Assert Statements
+ *
+ * @{
+ */
+
 #if defined( RTEMS_DEBUG )
   #include <assert.h>
 #endif
@@ -105,4 +123,6 @@ extern "C" {
 }
 #endif /* __cplusplus */
 
+/** @} */
+
 #endif /* _RTEMS_SCORE_ASSERT_H */




More information about the vc mailing list