From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 9DC65C880 for ; Tue, 23 Jun 2015 14:08:04 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga103.jf.intel.com with ESMTP; 23 Jun 2015 05:07:51 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,665,1427785200"; d="scan'208";a="748812414" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga002.fm.intel.com with ESMTP; 23 Jun 2015 05:07:49 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t5NC7mOH025519; Tue, 23 Jun 2015 13:07:48 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t5NC7mr4031433; Tue, 23 Jun 2015 13:07:48 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t5NC7mfT031428; Tue, 23 Jun 2015 13:07:48 +0100 From: John McNamara To: dev@dpdk.org Date: Tue, 23 Jun 2015 13:07:47 +0100 Message-Id: <1435061267-31388-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [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 12:08:05 -0000 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 --- 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, -- 1.8.1.4