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

[Sebastian Huber]

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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr 11 09:12:25 2019 +0200

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

Update #3706.

---

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

diff --git a/cpukit/include/rtems/score/profiling.h b/cpukit/include/rtems/score/profiling.h
index 83aa334..24bfc86 100644
--- a/cpukit/include/rtems/score/profiling.h
+++ b/cpukit/include/rtems/score/profiling.h
@@ -40,6 +40,14 @@ extern "C" {
  * @{
  */
 
+/**
+ * @brief Disables the thread dispatch if the previous thread dispatch
+ *      disable level is zero.
+ *
+ * @param[out] cpu The cpu control.
+ * @param previous_thread_dispatch_disable_level The dispatch disable
+ *      level of the previous thread.
+ */
 static inline void _Profiling_Thread_dispatch_disable(
   Per_CPU_Control *cpu,
   uint32_t previous_thread_dispatch_disable_level
@@ -58,6 +66,17 @@ static inline void _Profiling_Thread_dispatch_disable(
 #endif
 }
 
+/**
+ * @brief Disables the thread dispatch.
+ *
+ * Only if the previous thread dispatch disable level is zero.  This
+ * method also takes into account the lock_context.
+ *
+ * @param[out] cpu The cpu control.
+ * @param previous_thread_dispatch_disable_level The dispatch disable
+ *      level of the previous thread.
+ * @param lock_context The lock context.
+ */
 static inline void _Profiling_Thread_dispatch_disable_critical(
   Per_CPU_Control        *cpu,
   uint32_t                previous_thread_dispatch_disable_level,
@@ -78,6 +97,15 @@ static inline void _Profiling_Thread_dispatch_disable_critical(
 #endif
 }
 
+/**
+ * @brief Enables the thread dispatch.
+ *
+ * Only if the @a new_thread_dispatch_disable_level is 0.
+ *
+ * @param[out] cpu The cpu control.
+ * @param new_thread_dispatch_disable_level The dispatch disable level
+ *      of the new thread.
+ */
 static inline void _Profiling_Thread_dispatch_enable(
   Per_CPU_Control *cpu,
   uint32_t new_thread_dispatch_disable_level
@@ -104,6 +132,12 @@ static inline void _Profiling_Thread_dispatch_enable(
 #endif
 }
 
+/**
+ * @brief Updates the maximum interrupt delay.
+ *
+ * @param[out] cpu The cpu control.
+ * @param interrupt_delay The new interrupt delay.
+ */
 static inline void _Profiling_Update_max_interrupt_delay(
   Per_CPU_Control *cpu,
   CPU_Counter_ticks interrupt_delay
@@ -126,6 +160,10 @@ static inline void _Profiling_Update_max_interrupt_delay(
  *
  * Must be called with the interrupt stack and before the thread dispatch
  * disable level is decremented.
+ *
+ * @param cpu The cpu control.
+ * @param interrupt_entry_instant The instant that the interrupt occured.
+ * @param interrupt_exit_instant The instant in which the interrupt was exited.
  */
 void _Profiling_Outer_most_interrupt_entry_and_exit(
   Per_CPU_Control *cpu,