Changeset cf6ce4a in rtems


Ignore:
Timestamp:
Apr 8, 2019, 10:37:53 AM (3 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
4c99921
Parents:
d69b7a5
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/08/19 10:37:53)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rd69b7a5 rcf6ce4a  
    127127 * last block appears as used for the _Heap_Is_used() and _Heap_Is_free()
    128128 * functions.
    129  */
    130 /**@{**/
     129 *
     130 * @{
     131 */
    131132
    132133typedef struct Heap_Control Heap_Control;
     
    295296
    296297/**
    297  * @brief Extends the memory available for the heap @a heap using the memory
    298  * area starting at @a area_begin of size @a area_size bytes.
     298 * @brief Extends the memory available for the heap.
    299299 *
    300300 * There are no alignment requirements for the memory area.  The memory area
     
    305305 * behaviour.
    306306 *
    307  * The unused fourth parameter is provided to have the same signature as
    308  * _Heap_Initialize().
    309  *
    310  * Returns the extended space available for allocation, or zero in case of failure.
     307 * @param[in, out] heap The heap to extend.
     308 * @param[out] area_begin The start address of the area to extend the @a heap with.
     309 * @param area_size The size of the area in bytes.
     310 * @param unused Is not used, only provided to have the same signature as _Heap_Initialize().
     311 *
     312 * @retval some_value The extended space available for allocation after successful extension.
     313 * @retval 0 The heap extension failed.
    311314 *
    312315 * @see Heap_Initialization_or_extend_handler.
     
    324327 * This function only returns zero and does nothing else.
    325328 *
    326  * Returns always zero.
     329 * @param unused_0 This parameter does nothing.
     330 * @param unused_1 This parameter does nothing.
     331 * @param unused_2 This parameter does nothing.
     332 * @param unused_3 This parameter does nothing.
    327333 *
    328334 * @see Heap_Initialization_or_extend_handler.
     
    335341);
    336342
     343/**
     344 * @brief Aligns the value to a given alignment, rounding up.
     345 *
     346 * @param value The value to be aligned.
     347 * @param alignment The alignment for the value.
     348 *
     349 * @return The @a value aligned to the given @a alignment, rounded up.
     350 */
    337351RTEMS_INLINE_ROUTINE uintptr_t _Heap_Align_up(
    338352  uintptr_t value,
     
    349363}
    350364
     365/**
     366 * @brief Returns the minimal Heap Block size for the given page_size.
     367 *
     368 * @param page_size The page size for the heap.
     369 *
     370 * @return The minimal Heap Block size for the given @a page_size.
     371 */
    351372RTEMS_INLINE_ROUTINE uintptr_t _Heap_Min_block_size( uintptr_t page_size )
    352373{
     
    356377/**
    357378 * @brief Returns the worst case overhead to manage a memory area.
     379 *
     380 * @param page_size The page size to calculate the worst case memory manage overhead.
     381 *
     382 * @return The worst case overhead to manage a memory area.
    358383 */
    359384RTEMS_INLINE_ROUTINE uintptr_t _Heap_Area_overhead(
     
    373398 * @brief Returns the size with administration and alignment overhead for one
    374399 * allocation.
     400 *
     401 * @param page_size The page size for the allocation.
     402 * @param size The size to allocate.
     403 * @param alignment The alignment that needs to be considered.
     404 *
     405 * @return The size with administration and alignment overhead for one allocation.
    375406 */
    376407RTEMS_INLINE_ROUTINE uintptr_t _Heap_Size_with_overhead(
Note: See TracChangeset for help on using the changeset viewer.