From patchwork Mon Nov 10 17:47:27 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 40521 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f70.google.com (mail-la0-f70.google.com [209.85.215.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id F349A218DE for ; Mon, 10 Nov 2014 17:48:10 +0000 (UTC) Received: by mail-la0-f70.google.com with SMTP id ge10sf5491793lab.1 for ; Mon, 10 Nov 2014 09:48:08 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=rBdECCA3VBHL7bOL8qznqWxAdpMiCPKcY5Loe2tDQH0=; b=Q12GvFD0bpTs0pY5N7YOxL0VhhZfrJBuOmGibCTCbU/b0FR6L+5yUVMiyHmDToBTdY Nsbqh6ozKHahYaL2SwfKnBBtW5ZCVzyFgyDBDdL/Jav2ZoUCVwKWRCVVc6zdRNEoYgob Mo/VHHu18UkyO6JJbRPXCn+oIxkMI2opMDWBU4dEeLCdk1RXiuwrazcU2m6xX/ptqAp9 Uxn2InFlYYRr8/9cv63gBVHfR9+a0KuzNv1FDk2R45egubncZYAiAuuHHamn1uh2NWEv b6+r2ZrBAOLSwKkuYIViLAInAidKpLz3oJVsfuFseWtssixD08nVawz8jCHzymbtKshh lTAQ== X-Gm-Message-State: ALoCoQmjiCYUpZ6D8PxbR7GmkaBLuqdQLstyHqOJL2Q1t+9l6EVNwb6WkqyNWdA4Q/n2EG3xQON7 X-Received: by 10.112.162.6 with SMTP id xw6mr5387700lbb.4.1415641686255; Mon, 10 Nov 2014 09:48:06 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.18.226 with SMTP id z2ls498119lad.13.gmail; Mon, 10 Nov 2014 09:48:06 -0800 (PST) X-Received: by 10.152.1.74 with SMTP id 10mr31288228lak.61.1415641686007; Mon, 10 Nov 2014 09:48:06 -0800 (PST) Received: from mail-la0-f44.google.com (mail-la0-f44.google.com. [209.85.215.44]) by mx.google.com with ESMTPS id li1si27934441lab.112.2014.11.10.09.48.05 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 10 Nov 2014 09:48:05 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) client-ip=209.85.215.44; Received: by mail-la0-f44.google.com with SMTP id gf13so8232724lab.3 for ; Mon, 10 Nov 2014 09:48:04 -0800 (PST) X-Received: by 10.112.202.104 with SMTP id kh8mr31193113lbc.46.1415641684655; Mon, 10 Nov 2014 09:48:04 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.184.201 with SMTP id ew9csp132168lbc; Mon, 10 Nov 2014 09:48:03 -0800 (PST) X-Received: by 10.229.204.66 with SMTP id fl2mr41619898qcb.7.1415641683299; Mon, 10 Nov 2014 09:48:03 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id c110si32157127qge.77.2014.11.10.09.48.00 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 10 Nov 2014 09:48:03 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xnt4J-0007A3-NZ; Mon, 10 Nov 2014 17:47:59 +0000 Received: from mail-qa0-f52.google.com ([209.85.216.52]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xnt4C-00079r-Qx for lng-odp@lists.linaro.org; Mon, 10 Nov 2014 17:47:52 +0000 Received: by mail-qa0-f52.google.com with SMTP id u7so5577062qaz.39 for ; Mon, 10 Nov 2014 09:47:43 -0800 (PST) X-Received: by 10.224.38.130 with SMTP id b2mr45445472qae.11.1415641663232; Mon, 10 Nov 2014 09:47:43 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id p13sm7167110qax.8.2014.11.10.09.47.42 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 10 Nov 2014 09:47:42 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 10 Nov 2014 12:47:27 -0500 Message-Id: <1415641647-32957-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH v2] odp_shared_memory.h: add doxygen in/out X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Mike Holmes --- .../linux-generic/include/api/odp_shared_memory.h | 24 ++++++++++++---------- 1 file 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 1a59824..ff6f9a9 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 */