From patchwork Fri Nov 7 17:27:18 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 40444 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f69.google.com (mail-wg0-f69.google.com [74.125.82.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id CDD10218C0 for ; Fri, 7 Nov 2014 17:27:46 +0000 (UTC) Received: by mail-wg0-f69.google.com with SMTP id l18sf2161448wgh.4 for ; Fri, 07 Nov 2014 09:27:46 -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=GUOz5xBIB+NEYhorvZq4or2RBjM6cVWjr/r5qbo+KpM=; b=ENN7O/DxmW7JgRp9/jUaBxfar5GlUSW3pafjqICNZHgHLY/MFGdr8W8R8aY65Re3Hz b6MbOcVAFupzjhqPO1zQVqZYjSihl/FxeFVmHYRRo1re6nt20tnSwxhi+nphES78KcAb VflD7Dk8C6IEda1VXerlvjg/f2L4OgW/EEUKS8ctgzHwwdSB/57UJmBGQ8HfdLGR8325 8BsrLczW8VBrDfxb/kjmq4RjI+ML14IwLor7uVJWgGf55jcXBFfVM23TTxscBVVFhwGg lxXUwuJwblI2x7l2Nrk1BTJLPCIRV1CvF0xQjXP9WztRP9KRz0oXWro3it8kVlmX4pS+ 6png== X-Gm-Message-State: ALoCoQlDZq+PvqyyXGXdj40JL0QQdpk6V5+VOKMusTrVu2EJc/GyqSzZWS9aCdklk1JGATfI6/2k X-Received: by 10.181.8.194 with SMTP id dm2mr912788wid.2.1415381266053; Fri, 07 Nov 2014 09:27:46 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.161.234 with SMTP id xv10ls254256lab.99.gmail; Fri, 07 Nov 2014 09:27:45 -0800 (PST) X-Received: by 10.112.173.100 with SMTP id bj4mr4237501lbc.78.1415381265422; Fri, 07 Nov 2014 09:27:45 -0800 (PST) Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com. [209.85.217.179]) by mx.google.com with ESMTPS id g8si15863580lae.48.2014.11.07.09.27.45 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 07 Nov 2014 09:27:45 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.179 as permitted sender) client-ip=209.85.217.179; Received: by mail-lb0-f179.google.com with SMTP id l4so3063314lbv.10 for ; Fri, 07 Nov 2014 09:27:45 -0800 (PST) X-Received: by 10.152.120.199 with SMTP id le7mr12224964lab.67.1415381265323; Fri, 07 Nov 2014 09:27:45 -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 ew9csp238749lbc; Fri, 7 Nov 2014 09:27:44 -0800 (PST) X-Received: by 10.224.74.194 with SMTP id v2mr9334285qaj.60.1415381263761; Fri, 07 Nov 2014 09:27:43 -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 j7si17848097qch.37.2014.11.07.09.27.42 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 07 Nov 2014 09:27:43 -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 1XmnK1-0002aO-4y; Fri, 07 Nov 2014 17:27:41 +0000 Received: from mail-qg0-f43.google.com ([209.85.192.43]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XmnJu-0002aJ-JF for lng-odp@lists.linaro.org; Fri, 07 Nov 2014 17:27:34 +0000 Received: by mail-qg0-f43.google.com with SMTP id f51so2749357qge.30 for ; Fri, 07 Nov 2014 09:27:29 -0800 (PST) X-Received: by 10.140.107.132 with SMTP id h4mr18481997qgf.34.1415381249287; Fri, 07 Nov 2014 09:27:29 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id g4sm8824584qas.22.2014.11.07.09.27.28 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 07 Nov 2014 09:27:28 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Fri, 7 Nov 2014 12:27:18 -0500 Message-Id: <1415381238-42124-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] 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.217.179 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 | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 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..6836b28 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,7 +88,7 @@ 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 */ @@ -97,7 +98,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 +108,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 */