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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr 11 10:00:17 2019 +0200

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

Update #3706.

---

 cpukit/include/rtems/score/rbtreeimpl.h | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/cpukit/include/rtems/score/rbtreeimpl.h b/cpukit/include/rtems/score/rbtreeimpl.h
index a6d1a05..1b5b539 100644
--- a/cpukit/include/rtems/score/rbtreeimpl.h
+++ b/cpukit/include/rtems/score/rbtreeimpl.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSScoreRBTree
+ *
  * @brief Inlined Routines Associated with Red-Black Trees
  *
  * This include file contains the bodies of the routines which are
@@ -30,8 +32,9 @@ extern "C" {
 
 /**
  * @addtogroup RTEMSScoreRBTree
+ *
+ * @{
  */
-/**@{**/
 
 /**
  * @brief Red-black tree visitor.
@@ -52,9 +55,9 @@ typedef bool (*RBTree_Visitor)(
 /**
  * @brief Red-black tree iteration.
  *
- * @param[in] rbtree The red-black tree.
- * @param[in] visitor The visitor.
- * @param[in] visitor_arg The visitor argument.
+ * @param rbtree The red-black tree.
+ * @param visitor The visitor.
+ * @param visitor_arg The visitor argument.
  */
 void _RBTree_Iterate(
   const RBTree_Control *rbtree,



More information about the vc mailing list