ethdev: fix link speed helper documentation
authorDavid Marchand <david.marchand@redhat.com>
Tue, 29 Sep 2020 12:12:22 +0000 (14:12 +0200)
committerFerruh Yigit <ferruh.yigit@intel.com>
Tue, 29 Sep 2020 15:43:32 +0000 (17:43 +0200)
commitdc3cdcd69dd66e2e9328fc5bbc6e187c71b4f6a8
treee7aaddb2d1325a720a72ee995b60fd7fca71fb30
parent1f1619994570210105ea9fa674562c11ce1921b3
ethdev: fix link speed helper documentation

When generating the documentation, a new warning can be seen:

.../dpdk/lib/librte_ethdev/rte_ethdev.h:2441:
  warning: argument 'link_speed' of command @param is not found in the
  argument list of rte_eth_link_speed_to_str(uint32_t speed_link)
.../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
  parameters of rte_eth_link_speed_to_str(uint32_t speed_link) are not
  documented: parameter 'speed_link'

Align the function prototype to its doxygen description.

Fixes: fbf931c9c392 ("ethdev: format link status text")

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
lib/librte_ethdev/rte_ethdev.h