From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wi0-f174.google.com (mail-wi0-f174.google.com [209.85.212.174]) by dpdk.org (Postfix) with ESMTP id 0F19CC312 for ; Tue, 23 Jun 2015 17:04:38 +0200 (CEST) Received: by wibdq8 with SMTP id dq8so19805853wib.1 for ; Tue, 23 Jun 2015 08:04:38 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:message-id:date:from:user-agent:mime-version:to :subject:references:in-reply-to:content-type :content-transfer-encoding; bh=BDFGS+l06AqsiQh1WvzTBH2dojCh1VupN94OXWoL1QY=; b=XKCgKJBBbIHnWT4TusilI2EJrRozWqTBQKupAxr4ME4Dplra4SL2z3Tkxsy1EFrAGk QOzdjOXuUPN+Is7a6tcOKLOPhzLiYcL76FxW/yvc59/Z0TPRQmbq124KAHqVQiVRjF2X yvXTirjw+MKf6pl4GI/hY2cyShn7xyeveXGhkppAO1DV2A0LiMzfZ/CdtgMm+rmb1v2r VU+1o+A51Tpm/07x3oHMNKiqWhQBubAINQCgPknyN05jWPgYT3xPoOqgIZOBeiKIjnLZ fxI3GwegCwzjlb/+LBHdAh/PxkBMKmjWbhMnAJRb5v3TsmyxCv8R2YYEKfhpWUbp4sBI oYvQ== X-Gm-Message-State: ALoCoQnfiVMu3KAv4OmPDDBCKbbx9K/dT9PFhxgvORMQGMxLHKNXXpHapYHxZMUo1xyBtwm9MjX9 X-Received: by 10.194.71.105 with SMTP id t9mr60491146wju.128.1435071877914; Tue, 23 Jun 2015 08:04:37 -0700 (PDT) Received: from [10.16.0.195] (6wind.net2.nerim.net. [213.41.151.210]) by mx.google.com with ESMTPSA id d3sm22742831wic.1.2015.06.23.08.04.36 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 23 Jun 2015 08:04:37 -0700 (PDT) Message-ID: <5589757E.6030405@6wind.com> Date: Tue, 23 Jun 2015 17:04:30 +0200 From: Olivier MATZ User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Icedove/31.6.0 MIME-Version: 1.0 To: John McNamara , dev@dpdk.org References: <1435061267-31388-1-git-send-email-john.mcnamara@intel.com> In-Reply-To: <1435061267-31388-1-git-send-email-john.mcnamara@intel.com> Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH] mempool: add missing api parameter documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 23 Jun 2015 15:04:38 -0000 On 06/23/2015 02:07 PM, John McNamara wrote: > Added Doxygen @param for missing API parameter in > rte_mempool_obj_iter(), to fix Doxygen warning. Also added > minor grammar fixes to that function documentation. > > Signed-off-by: John McNamara Acked-by: Olivier Matz > --- > lib/librte_mempool/rte_mempool.h | 11 ++++++----- > 1 file changed, 6 insertions(+), 5 deletions(-) > > diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h > index a8054e1..f16019a 100644 > --- a/lib/librte_mempool/rte_mempool.h > +++ b/lib/librte_mempool/rte_mempool.h > @@ -393,11 +393,11 @@ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, > * > * Iterate across objects of the given size and alignment in the > * provided chunk of memory. The given memory buffer can consist of > - * disjoint physical pages. > + * disjointed physical pages. > * > - * For each object, calls the provided callback (if any). This function > - * is used to populate mempool, walk through all elements of the > - * mempool, estimate how many elements of the given size could be > + * For each object, call the provided callback (if any). This function > + * is used to populate a mempool, or walk through all the elements of a > + * mempool, or estimate how many elements of the given size could be > * created in the given memory buffer. > * > * @param vaddr > @@ -406,6 +406,8 @@ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, > * Maximum number of objects to iterate through. > * @param elt_sz > * Size of each object. > + * @param align > + * Alignment of each object. > * @param paddr > * Array of physical addresses of the pages that comprises given memory > * buffer. > @@ -421,7 +423,6 @@ typedef void (*rte_mempool_obj_iter_t)(void * /*obj_iter_arg*/, > * @return > * Number of objects iterated through. > */ > - > uint32_t rte_mempool_obj_iter(void *vaddr, > uint32_t elt_num, size_t elt_sz, size_t align, > const phys_addr_t paddr[], uint32_t pg_num, uint32_t pg_shift, >