Re: [dpdk-dev] [PATCH] hash: fix typo in Doxygen comment

[Bruce Richardson <bruce.richardson@intel.com>]

On Thu, Mar 24, 2016 at 02:27:46PM +0000, Pablo de Lara wrote:
> rte_hash_set_cmp_func() had an incorrect Doxygen comment
> for one of its parameters.
> 
> Fixes: 95da2f8e9c61 ("hash: customize compare function")
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> ---
>  lib/librte_hash/rte_hash.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/librte_hash/rte_hash.h b/lib/librte_hash/rte_hash.h
> index 85fc416..add3414 100644
> --- a/lib/librte_hash/rte_hash.h
> +++ b/lib/librte_hash/rte_hash.h
> @@ -114,7 +114,7 @@ rte_hash_create(const struct rte_hash_parameters *params);
>   * in multi-process mode.
>   *
>   * @param h
> - *   Hash table to reset
> + *   Hash table to change the function

Good idea to change this. However, to read correctly, I think it might need to
be adjusted slightly. E.g.

* Hash table for which the function is to be changed
* Hash table to update

Regards,
/Bruce

>   * @param func
>   *   New compare function
>   */
> -- 
> 2.5.5
>