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

[Sebastian Huber]

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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Thu Apr 18 09:54:49 2019 +0200

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

Update #3706.

---

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

diff --git a/cpukit/include/rtems/score/onceimpl.h b/cpukit/include/rtems/score/onceimpl.h
index eee3189..921c492 100644
--- a/cpukit/include/rtems/score/onceimpl.h
+++ b/cpukit/include/rtems/score/onceimpl.h
@@ -39,10 +39,36 @@ extern "C" {
  * @{
  */
 
+/**
+ * @brief Reacts according to the state of once_state.
+ *
+ * If once_state is ONCE_STATE_INIT, then the once state is set first to
+ * ONCE_STATE_RUNNING and after calling the init routine it is set to
+ * ONCE_STATE_COMPLETED. If once_state is ONCE_STATE_COMPLETED, nothing
+ * happens. If once_state is not either one, this method waits for the
+ * Once_Information_Mutex.
+ *
+ * @param once_state The once state.
+ * @param init_routine The initialization routine called if @a once_state is ONCE_STATE_INIT.
+ *
+ * @return This method always returns zero upon termination.
+ */
 int _Once( unsigned char *once_state, void ( *init_routine )( void ) );
 
+/**
+ * @brief Locks the Once_Information_Mutex and returns the thread life state.
+ *
+ * @return The thread life state (THREAD_LIFE_PROTECTED).
+ */
 Thread_Life_state _Once_Lock( void );
 
+/**
+ * @brief Unlocks the Once_Information_Mutex and sets the thread life
+ *      protection to thread_life_state.
+ *
+ * @param thread_life_state The thread life state to set the thread life
+ *      protection to.
+ */
 void _Once_Unlock( Thread_Life_state thread_life_state );
 
 /** @} */