Changeset 93dcd2b in rtems


Ignore:
Timestamp:
Apr 4, 2019, 7:01:43 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
76a9857c
Parents:
dda1922
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/04/19 07:01:43)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:02)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rdda1922 r93dcd2b  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  @brief Information Required to Manipulate Physical Addresses
     4 * @ingroup RTEMSScoreAddress
    55 *
    6  *  This include file contains the information required to manipulate
    7  *  physical addresses.
     6 * @brief Information Required to Manipulate Physical Addresses
     7 *
     8 * This include file contains the information required to manipulate
     9 * physical addresses.
    810 */
    911
     
    2729
    2830/**
    29  *  @defgroup RTEMSScoreAddress Address Handler
     31 * @defgroup RTEMSScoreAddress Address Handler
    3032 *
    31  *  @ingroup RTEMSScore
     33 * @ingroup RTEMSScore
    3234 *
    33  *  This handler encapsulates functionality which abstracts address
    34  *  manipulation in a portable manner.
     35 * @brief Support for Address Manipulation
     36 *
     37 * This handler encapsulates functionality which abstracts address
     38 * manipulation in a portable manner.
     39 *
     40 * @{
    3541 */
    36 /**@{*/
    3742
    3843/**
    39  * @brief Add offset to an address.
     44 * @brief Adds offset to an address.
    4045 *
    4146 * This function is used to add an @a offset to a @a base address.
     
    4348 * converted to an access type before being used further.
    4449 *
    45  * @param[in] base is the base address.
    46  * @param[in] offset is the offset to add to @a base.
     50 * @param base The base address to add the offset to.
     51 * @param offset The offset to add to @a base.
    4752 *
    4853 * @return This method returns the resulting address.
     
    5762
    5863/**
    59  * @brief Subtract offset from offset.
     64 * @brief Subtracts offset from an address.
    6065 *
    6166 * This function is used to subtract an @a offset from a @a base
     
    6368 * typically converted to an access type before being used further.
    6469 *
    65  * @param[in] base is the base address.
    66  * @param[in] offset is the offset to subtract to @a base.
     70 * @param base The base address to subtract the offset from.
     71 * @param offset The offset to subtract from @a base.
    6772 *
    6873 * @return This method returns the resulting address.
     
    7883
    7984/**
    80  * @brief Subtract two addresses.
     85 * @brief Subtracts two addresses.
    8186 *
    8287 * This function is used to subtract two addresses.  It returns the
    8388 * resulting offset.
    8489 *
    85  * @param[in] left is the address on the left hand side of the subtraction.
    86  * @param[in] right is the address on the right hand side of the subtraction.
     90 * @param left The address on the left hand side of the subtraction.
     91 * @param right The address on the right hand side of the subtraction.
    8792 *
    8893 * @return This method returns the resulting address.
     
    97102
    98103/**
    99  * @brief Is address aligned.
     104 * @brief Checks if address is aligned.
    100105 *
    101106 * This function returns true if the given address is correctly
     
    103108 * is based on correctness and efficiency.
    104109 *
    105  * @param[in] address is the address being checked for alignment.
     110 * @param address The address being checked for alignment.
    106111 *
    107112 * @retval true The @a address is aligned.
     
    116121
    117122/**
    118  * @brief Is address in range.
     123 * @brief Checks if address is in range.
    119124 *
    120125 * This function returns true if the given address is within the
    121  * memory range specified and false otherwise.  base is the address
    122  * of the first byte in the memory range and limit is the address
     126 * memory range specified and false otherwise.  @a base is the address
     127 * of the first byte in the memory range and @a limit is the address
    123128 * of the last byte in the memory range.  The base address is
    124129 * assumed to be lower than the limit address.
    125130 *
    126  * @param[in] address is the address to check.
    127  * @param[in] base is the lowest address of the range to check against.
    128  * @param[in] limit is the highest address of the range to check against.
     131 * @param address The address to check if it is in the given range.
     132 * @param base The lowest address of the range to check against.
     133 * @param limit The highest address of the range to check against.
    129134 *
    130135 * @retval true The @a address is within the memory range specified
     
    141146
    142147/**
    143  * @brief Align address to nearest multiple of alignment, rounding up.
     148 * @brief Aligns address to nearest multiple of alignment, rounding up.
    144149 *
    145150 * This function returns the given address aligned to the given alignment.
     
    148153 * given address.
    149154 *
    150  * @param[in] address is the address to align.
    151  * @param[in] alignment is the boundary for alignment and must be a power of 2
     155 * @param address The address to align to the given alignment.
     156 * @param alignment The desired alignment for the address. It must be a power of two.
    152157 *
    153158 * @return Returns the aligned address.
     
    163168
    164169/**
    165  * @brief Align address to nearest multiple of alignment, truncating.
     170 * @brief Aligns address to nearest multiple of alignment, truncating.
    166171 *
    167172 * This function returns the given address aligned to the given alignment.
     
    170175 * given address.
    171176 *
    172  * @param[in] address is the address to align.
    173  * @param[in] alignment is the boundary for alignment and must be a power of 2.
     177 * @param address The address to align to the given alignment.
     178 * @param alignment The desired alignment for the address. It must be a power of two.
    174179 *
    175180 * @return Returns the aligned address.
     
    184189}
    185190
    186 /**@}*/
     191/** @} */
    187192
    188193#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.