[dpdk-dev] ethdev: remove wrong doxygen for rte_eth_copy_pci_info().

Message ID 1501277705-26556-1-git-send-email-rami.rosen@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Rami Rosen July 28, 2017, 9:35 p.m. UTC
  This trivial patch removes wrong comments about
the return value of the rte_eth_copy_pci_info() method.
The method return value type is void.

Signed-off-by: Rami Rosen <rami.rosen@intel.com>
---
 lib/librte_ether/rte_ethdev_pci.h | 2 --
 1 file changed, 2 deletions(-)
  

Comments

Thomas Monjalon July 31, 2017, 9:34 p.m. UTC | #1
28/07/2017 23:35, Rami Rosen:
> This trivial patch removes wrong comments about
> the return value of the rte_eth_copy_pci_info() method.
> The method return value type is void.
> 
> Signed-off-by: Rami Rosen <rami.rosen@intel.com>

Applied, thanks
  

Patch

diff --git a/lib/librte_ether/rte_ethdev_pci.h b/lib/librte_ether/rte_ethdev_pci.h
index c3f7f721c384..27bba2b519e1 100644
--- a/lib/librte_ether/rte_ethdev_pci.h
+++ b/lib/librte_ether/rte_ethdev_pci.h
@@ -46,8 +46,6 @@ 
  * @param pci_dev
  * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
  *
- * @return
- *   - 0 on success, negative on error
  */
 static inline void
 rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,