diff mbox

[dpdk-dev] mempool: add missing api parameter documentation

Message ID 1435061267-31388-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers show

Commit Message

Mcnamara, John June 23, 2015, 12:07 p.m. UTC
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 <john.mcnamara@intel.com>
---
 lib/librte_mempool/rte_mempool.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Olivier Matz June 23, 2015, 3:04 p.m. UTC | #1
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 <john.mcnamara@intel.com>

Acked-by: Olivier Matz <olivier.matz@6wind.com>



> ---
>   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,
>
Thomas Monjalon June 23, 2015, 3:46 p.m. UTC | #2
2015-06-23 17:04, Olivier MATZ:
> 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 <john.mcnamara@intel.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks
Thomas Monjalon June 23, 2015, 4:01 p.m. UTC | #3
2015-06-23 17:04, Olivier MATZ:
> 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 <john.mcnamara@intel.com>
> 
> Acked-by: Olivier Matz <olivier.matz@6wind.com>

Applied, thanks
diff mbox

Patch

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,