doc: remove '@return None' for void functions

doxygen will warn that documented return type is found for functions
that does not return anything in 1.9.4 or later versions. 'None' is
not a special keyword in doxyge, it will recognize it as description
to the return value that does not exist in void functions.

Tracked-On: #8425
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@linux.intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Jiaqing Zhao
2023-06-07 09:11:30 +00:00
committed by David Kinder
parent 917f906268
commit 7bfbdf04b8
27 changed files with 3 additions and 208 deletions

View File

@@ -346,8 +346,6 @@ void vdev_pt_write_vbar(struct pci_vdev *vdev, uint32_t idx, uint32_t val)
* @pre vdev != NULL
* @pre vdev->vpci != NULL
* @pre vdev->pdev != NULL
*
* @return None
*/
static void init_bars(struct pci_vdev *vdev, bool is_sriov_bar)
{
@@ -542,7 +540,7 @@ void passthru_gpu_opregion(struct pci_vdev *vdev)
pci_vdev_write_vcfg(vdev, PCIR_ASLS_CTL, 4U, gpu_opregion_gpa | (gpu_asls_phys & ~PCIM_ASLS_OPREGION_MASK));
}
/*
/**
* @brief Initialize a specified passthrough vdev structure.
*
* The function init_vdev_pt is used to initialize a vdev structure. If a vdev structure supports
@@ -556,8 +554,6 @@ void passthru_gpu_opregion(struct pci_vdev *vdev)
* @pre vdev != NULL
* @pre vdev->vpci != NULL
* @pre vdev->pdev != NULL
*
* @return None
*/
void init_vdev_pt(struct pci_vdev *vdev, bool is_pf_vdev)
{
@@ -614,7 +610,7 @@ void init_vdev_pt(struct pci_vdev *vdev, bool is_pf_vdev)
}
/*
/**
* @brief Destruct a specified passthrough vdev structure.
*
* The function deinit_vdev_pt is the destructor corresponding to the function init_vdev_pt.
@@ -622,8 +618,6 @@ void init_vdev_pt(struct pci_vdev *vdev, bool is_pf_vdev)
* @param vdev pointer to vdev data structure
*
* @pre vdev != NULL
*
* @return None
*/
void deinit_vdev_pt(struct pci_vdev *vdev) {

View File

@@ -846,7 +846,7 @@ void vpci_update_one_vbar(struct pci_vdev *vdev, uint32_t bar_idx, uint32_t val,
}
}
/*
/**
* @brief Add emulated legacy PCI capability support for virtual PCI device
*
* @param vdev Pointer to vdev data structure
@@ -855,8 +855,6 @@ void vpci_update_one_vbar(struct pci_vdev *vdev, uint32_t bar_idx, uint32_t val,
*
* @pre vdev != NULL
* @pre vdev->vpci != NULL
*
* @return None
*/
uint32_t vpci_add_capability(struct pci_vdev *vdev, uint8_t *capdata, uint8_t caplen)
{