[PATCH 10/98] doxygen: score: added dox in assert.h according to doxygen guidelines

Sebastian Huber sebastian.huber at embedded-brains.de
Tue May 7 05:39:15 UTC 2019


From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

---
 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 d4432838ce..6c68d9d28d 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 */
-- 
2.16.4




More information about the devel mailing list