doc: always use 'None' for functions not returning a value

It is preferred to state the absence of a return value explicitly in the
doxygen-stile comments. Currently there are different styles of doing this,
including:

  @return None
  @return NULL
  @return void
  @return N/A

This patch unifies the above with `@return None`.

Tracked-On: #1595
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Junjie Mao
2018-11-21 17:27:56 +08:00
committed by Eddie Dong
parent cbe1b74eee
commit 97eb72a4a0
13 changed files with 51 additions and 51 deletions

View File

@@ -1644,7 +1644,7 @@ pci_msix_enabled(struct pci_vdev *dev)
* @param dev Pointer to struct pci_vdev representing virtual PCI device.
* @param index MSIx table entry index.
*
* @return N/A
* @return None
*/
void
pci_generate_msix(struct pci_vdev *dev, int index)
@@ -1673,7 +1673,7 @@ pci_generate_msix(struct pci_vdev *dev, int index)
* @param dev Pointer to struct pci_vdev representing virtual PCI device.
* @param index Message data index.
*
* @return N/A
* @return None
*/
void
pci_generate_msi(struct pci_vdev *dev, int index)
@@ -1781,7 +1781,7 @@ pci_lintr_route(struct pci_vdev *dev)
*
* @param dev Pointer to struct pci_vdev representing virtual PCI device.
*
* @return N/A
* @return None
*/
void
pci_lintr_assert(struct pci_vdev *dev)
@@ -1804,7 +1804,7 @@ pci_lintr_assert(struct pci_vdev *dev)
*
* @param dev Pointer to struct pci_vdev representing virtual PCI device.
*
* @return N/A
* @return None
*/
void
pci_lintr_deassert(struct pci_vdev *dev)