Changeset 7b90bb5 in rtems


Ignore:
Timestamp:
Apr 18, 2019, 7:38:47 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
2463c10
Parents:
904c2312
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 07:38:47)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/wkspace.h

    r904c2312 r7b90bb5  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  @brief Information Related to the RAM Workspace
     4 * @ingroup RTEMSScoreWorkspace
    55 *
    6  *  This include file contains information related to the
    7  *  RAM Workspace.  This Handler provides mechanisms which can be used to
    8  *  define, initialize and manipulate the workspace.
     6 * @brief Information Related to the RAM Workspace
     7 *
     8 * This include file contains information related to the
     9 * RAM Workspace.  This Handler provides mechanisms which can be used to
     10 * define, initialize and manipulate the workspace.
    911 */
    1012
     
    2931
    3032/**
    31  *  @defgroup RTEMSScoreWorkspace Workspace Handler
     33 * @defgroup RTEMSScoreWorkspace Workspace Handler
    3234 *
    33  *  @ingroup RTEMSScore
     35 * @ingroup RTEMSScore
    3436 *
    35  *  This handler encapsulates functionality related to the management of
    36  *  the RTEMS Executive Workspace.
     37 * This handler encapsulates functionality related to the management of
     38 * the RTEMS Executive Workspace.
     39 *
     40 * @{
    3741 */
    38 /**@{*/
    3942
    4043/**
     
    4750
    4851/**
    49  * @brief Initilize workspace handler.
     52 * @brief Initilizes the workspace handler.
    5053 *
    51  *  This routine performs the initialization necessary for this handler.
     54 * This routine performs the initialization necessary for this handler.
     55 *
     56 * @param areas The heap area for the new workspace.
     57 * @param area_count The number of areas for the allocation.
     58 * @param extend The extension handler for the new workspace.
    5259 */
    5360void _Workspace_Handler_initialization(
     
    7077
    7178/**
    72  * @brief Allocate aligned memory from workspace.
     79 * @brief Allocates aligned memory from workspace.
    7380 *
    74  * @param[in] size The size of the requested memory.
    75  * @param[in] alignment The alignment of the requested memory.
     81 * @param size The size of the requested memory.
     82 * @param alignment The alignment of the requested memory.
    7683 *
     84 * @retval other The memory area begin.
    7785 * @retval NULL Not enough resources.
    78  * @retval other The memory area begin.
    7986 */
    8087void *_Workspace_Allocate_aligned( size_t size, size_t alignment );
    8188
    8289/**
    83  * @brief Free memory to the workspace.
     90 * @brief Frees memory to the workspace.
    8491 *
    85  *  This function frees the specified block of memory.  If the block
    86  *  belongs to the Workspace and can be successfully freed, then
    87  *  true is returned.  Otherwise false is returned.
     92 * This function frees the specified block of memory.
    8893 *
    89  *  @param block is the memory to free
     94 * @param block The memory to free.
    9095 *
    91  *  @note If @a block is equal to NULL, then the request is ignored.
     96 * @note If @a block is equal to NULL, then the request is ignored.
    9297 *        This allows the caller to not worry about whether or not
    9398 *        a pointer is NULL.
    9499 */
    95 
    96100void _Workspace_Free(
    97101  void *block
     
    99103
    100104/**
    101  * @brief Workspace allocate or fail with fatal error.
     105 * @brief Allocates workspace or fails with fatal error.
    102106 *
    103  *  This routine returns the address of a block of memory of @a size
    104  *  bytes.  If a block of the appropriate size cannot be allocated
    105  *  from the workspace, then the internal error handler is invoked.
     107 * This routine returns the address of a block of memory of @a size
     108 * bytes.  If a block of the appropriate size cannot be allocated
     109 * from the workspace, then the internal error handler is invoked.
    106110 *
    107  *  @param[in] size is the desired number of bytes to allocate
    108  *  @retval If successful, the starting address of the allocated memory
     111 * @param size is the desired number of bytes to allocate
     112 *
     113 * @return The starting address of the allocated memory.
    109114 */
    110115void *_Workspace_Allocate_or_fatal_error(
     
    115120 * @brief Duplicates string with memory from the workspace.
    116121 *
    117  * @param[in] string is the pointer to a zero terminated string.
    118  * @param[in] len is the length of the string (equal to strlen(string)).
     122 * @param string The pointer to a zero terminated string.
     123 * @param len The length of the string (equal to strlen(string)).
    119124 *
     125 * @retval other Duplicated string.
    120126 * @retval NULL Not enough memory.
    121  * @retval other Duplicated string.
    122127 */
    123128char *_Workspace_String_duplicate(
     
    126131);
    127132
    128 /**@}*/
     133/** @} */
    129134
    130135#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.