[PATCH 46/98] doxygen: score: adjust doc in schedulercbsimpl.h to doxygen guidelines

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


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

---
 cpukit/include/rtems/score/schedulercbsimpl.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/cpukit/include/rtems/score/schedulercbsimpl.h b/cpukit/include/rtems/score/schedulercbsimpl.h
index d4a9ae2ba2..7985adb220 100644
--- a/cpukit/include/rtems/score/schedulercbsimpl.h
+++ b/cpukit/include/rtems/score/schedulercbsimpl.h
@@ -36,6 +36,13 @@ extern "C" {
  * @{
  */
 
+/**
+ * @brief Gets the CBS node of the thread.
+ *
+ * @param the_thread The thread to get the CBS node of.
+ *
+ * @return Pointer to the scheduler node of @a the_thread.
+ */
 RTEMS_INLINE_ROUTINE Scheduler_CBS_Node *_Scheduler_CBS_Thread_get_node(
   Thread_Control *the_thread
 )
@@ -43,6 +50,13 @@ RTEMS_INLINE_ROUTINE Scheduler_CBS_Node *_Scheduler_CBS_Thread_get_node(
   return (Scheduler_CBS_Node *) _Thread_Scheduler_get_home_node( the_thread );
 }
 
+/**
+ * @brief Casts the scheduler node to a scheduler CBS node.
+ *
+ * @param node The node to be casted to a scheduler CBS node.
+ *
+ * @return CBS Node pointer to @a node.
+ */
 RTEMS_INLINE_ROUTINE Scheduler_CBS_Node *_Scheduler_CBS_Node_downcast(
   Scheduler_Node *node
 )
-- 
2.16.4




More information about the devel mailing list