From 46f198acf23db8de6c6d5e8f331d679d406785e3 Mon Sep 17 00:00:00 2001 From: Olivier Matz Date: Tue, 17 May 2016 11:59:46 +0200 Subject: [PATCH] pci: fix typos in ioport doxygen comments Fix some typos and add missing comments related to ioports API in rte_pci.h. Fixes: 756ce64b1 ("eal: introduce PCI ioport API") Signed-off-by: Olivier Matz --- lib/librte_eal/common/include/rte_pci.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/librte_eal/common/include/rte_pci.h b/lib/librte_eal/common/include/rte_pci.h index 43d17b36e1..b9072eb8b7 100644 --- a/lib/librte_eal/common/include/rte_pci.h +++ b/lib/librte_eal/common/include/rte_pci.h @@ -525,12 +525,13 @@ struct rte_pci_ioport { }; /** - * Initialises a rte_pci_ioport object for a pci device io resource. + * Initialize a rte_pci_ioport object for a pci device io resource. + * * This object is then used to gain access to those io resources (see below). * * @param dev - * A pointer to a rte_pci_device structure describing the device. - * to use + * A pointer to a rte_pci_device structure describing the device + * to use. * @param bar * Index of the io pci resource we want to access. * @param p @@ -546,6 +547,8 @@ int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar, * * @param p * The rte_pci_ioport object to be uninitialized. + * @return + * 0 on success, negative on error. */ int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p); -- 2.20.1