diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2014-11-10 12:47:27 -0500 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2014-11-13 15:19:36 +0300 |
| commit | 7e60f114ad5cb979aa2f35a0b0046c2067dada86 (patch) | |
| tree | 24f84003d9da33ca2e2947a82282578ca7763a50 /platform | |
| parent | 0eb3beb850afbee44ef980f771a325f54ab1a211 (diff) | |
odp_shared_memory.h: add doxygen in/out
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'platform')
| -rw-r--r-- | platform/linux-generic/include/api/odp_shared_memory.h | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/platform/linux-generic/include/api/odp_shared_memory.h b/platform/linux-generic/include/api/odp_shared_memory.h index 1a598240f..ff6f9a912 100644 --- a/platform/linux-generic/include/api/odp_shared_memory.h +++ b/platform/linux-generic/include/api/odp_shared_memory.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2013, Linaro Limited +/* Copyright (c) 2013-2014, Linaro Limited * All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause @@ -61,10 +61,11 @@ typedef struct odp_shm_info_t { /** * Reserve a contiguous block of shared memory * - * @param name Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars) - * @param size Block size in bytes - * @param align Block alignment in bytes - * @param flags Shared mem parameter flags (ODP_SHM_*). Default value is 0. + * @param[in] name Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars) + * @param[in] size Block size in bytes + * @param[in] align Block alignment in bytes + * @param[in] flags Shared memory parameter flags (ODP_SHM_*). + * Default value is 0. * * @return Pointer to the reserved block, or NULL */ @@ -75,7 +76,7 @@ odp_shm_t odp_shm_reserve(const char *name, uint64_t size, uint64_t align, * Free a contiguous block of shared memory * * Frees a previously reserved block of shared memory. - * @note Freeing memory that is in use will result in UNDEFINED behaviour. + * @note Freeing memory that is in use will result in UNDEFINED behavior * * @param[in] shm Block handle * @@ -87,9 +88,10 @@ int odp_shm_free(odp_shm_t shm); /** * Lookup for a block of shared memory * - * @param name Name of the block + * @param[in] name Name of the block * - * @return Pointer to the block, or NULL + * @return A handle to the block if it is found by name + * @retval #ODP_SHM_INVALID if the block is not found */ odp_shm_t odp_shm_lookup(const char *name); @@ -97,7 +99,7 @@ odp_shm_t odp_shm_lookup(const char *name); /** * Shared memory block address * - * @param shm Block handle + * @param[in] shm Block handle * * @return Memory block address, or NULL on error */ @@ -107,8 +109,8 @@ void *odp_shm_addr(odp_shm_t shm); /** * Shared memory block info * - * @param shm Block handle - * @param info Block info pointer for output + * @param[in] shm Block handle + * @param[out] info Block info pointer for output * * @return 0 on success, otherwise non-zero */ |