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

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


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Fri Apr 12 12:00:26 2019 +0200

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

Update #3706.

---

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

diff --git a/cpukit/include/rtems/score/schedulernode.h b/cpukit/include/rtems/score/schedulernode.h
index d62e983..66033c1 100644
--- a/cpukit/include/rtems/score/schedulernode.h
+++ b/cpukit/include/rtems/score/schedulernode.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreScheduler
+ *
+ * @brief Handles Scheduler Nodes.
+ */
+
 /*
  * Copyright (c) 2014, 2016 embedded brains GmbH.  All rights reserved.
  *
@@ -20,6 +28,12 @@
 #include <rtems/score/priority.h>
 #include <rtems/score/smplockseq.h>
 
+/**
+ * @addtogroup RTEMSScoreScheduler
+ *
+ * @{
+ */
+
 struct _Thread_Control;
 
 #ifdef __cplusplus
@@ -214,4 +228,6 @@ extern const size_t _Scheduler_Node_size;
 }
 #endif /* __cplusplus */
 
+/** @} */
+
 #endif /* _RTEMS_SCORE_SCHEDULERNODE_H */




More information about the vc mailing list