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

[Sebastian Huber]

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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Tue Apr 16 07:52:50 2019 +0200

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

Update #3706.

---

 cpukit/include/rtems/score/stackimpl.h | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/cpukit/include/rtems/score/stackimpl.h b/cpukit/include/rtems/score/stackimpl.h
index a7cea81..98eda31 100644
--- a/cpukit/include/rtems/score/stackimpl.h
+++ b/cpukit/include/rtems/score/stackimpl.h
@@ -1,6 +1,8 @@
 /**
  * @file
  *
+ * @ingroup RTEMSScoreStack
+ *
  * @brief Inlined Routines from the Stack Handler
  *
  * This file contains the static inline implementation of the inlined
@@ -27,13 +29,20 @@ extern "C" {
 
 /**
  * @addtogroup RTEMSScoreStack
+ *
+ * @{
  */
-/**@{**/
 
 /**
+ * @brief Initializes stack with the given starting address and size.
+ *
  * This routine initializes the_stack record to indicate that
  * size bytes of memory starting at starting_address have been
  * reserved for a stack.
+ *
+ * @param[out] the_stack The stack to initialize.
+ * @param starting_address The starting_address for the new stack.
+ * @param size The size of the stack in bytes.
  */
 RTEMS_INLINE_ROUTINE void _Stack_Initialize (
   Stack_Control *the_stack,
@@ -46,10 +55,12 @@ RTEMS_INLINE_ROUTINE void _Stack_Initialize (
 }
 
 /**
+ * @brief Returns the minimum stack size.
+ *
  * This function returns the minimum stack size configured
  * for this application.
  *
- * @return This method returns the minimum stack size;
+ * @return The minimum stack size.
  */
 RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
 {
@@ -57,12 +68,15 @@ RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
 }
 
 /**
+ * @brief Checks if the size is enough for a valid stack area on this processor.
+ *
  * This function returns true if size bytes is enough memory for
  * a valid stack area on this processor, and false otherwise.
  *
- * @param[in] size is the stack size to check
+ * @param size The stack size to check.
  *
- * @return This method returns true if the stack is large enough.
+ * @retval true @a size is large enough.
+ * @retval false @a size is not large enough.
  */
 RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
   size_t size
@@ -72,13 +86,15 @@ RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
 }
 
 /**
+ * @brief Returns the appropriate stack size for the requested size.
+ *
  * This function returns the appropriate stack size given the requested
  * size.  If the requested size is below the minimum, then the minimum
  * configured stack size is returned.
  *
- * @param[in] size is the stack size to check
+ * @param size The stack size to check.
  *
- * @return This method returns the appropriate stack size.
+ * @return The appropriate stack size.
  */
 RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
   size_t size