github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-01 08:56:55 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
hypervisor/include/arch/x86/guest/vioapic.h
View File

@@ -80,7 +80,7 @@ void vioapic_reset(struct acrn_vioapic *vioapic);
*
* @pre irq < vioapic_pincount(vm)
*
* @return void
* @return None
*/
void vioapic_set_irq(struct acrn_vm *vm, uint32_t irq, uint32_t operation);
@@ -96,7 +96,7 @@ void vioapic_set_irq(struct acrn_vm *vm, uint32_t irq, uint32_t operation);
* GSI_RAISING_PULSE/GSI_FALLING_PULSE
*
* @pre irq < vioapic_pincount(vm)
* @return void
* @return None
*/
void vioapic_set_irq_nolock(struct acrn_vm *vm, uint32_t irq, uint32_t operation);
void vioapic_update_tmr(struct acrn_vcpu *vcpu);

4
hypervisor/include/arch/x86/guest/vlapic.h
View File

@@ -145,7 +145,7 @@ int vlapic_pending_intr(const struct acrn_vlapic *vlapic, uint32_t *vecptr);
* @param[in] vlapic Pointer to target vLAPIC data structure
* @param[in] vector Target virtual interrupt vector
*
* @return void
* @return None
*
* @pre vlapic != NULL
*/
@@ -161,7 +161,7 @@ void vlapic_intr_accepted(struct acrn_vlapic *vlapic, uint32_t vector);
*
* @param[in] dest_pcpu_id Target CPU ID.
*
* @return void
* @return None
*/
void vlapic_post_intr(uint16_t dest_pcpu_id);

6
hypervisor/include/arch/x86/guest/vpic.h
View File

@@ -148,7 +148,7 @@ void vpic_init(struct acrn_vm *vm);
* @param[in] operation action options:GSI_SET_HIGH/GSI_SET_LOW/
* GSI_RAISING_PULSE/GSI_FALLING_PULSE
*
* @return void
* @return None
*/
void vpic_set_irq(struct acrn_vm *vm, uint32_t irq, uint32_t operation);
@@ -159,7 +159,7 @@ void vpic_set_irq(struct acrn_vm *vm, uint32_t irq, uint32_t operation);
* @param[inout] vecptr Pointer to vector buffer and will be filled
* with eligible vector if any.
*
* @return void.
* @return None
*/
void vpic_pending_intr(struct acrn_vm *vm, uint32_t *vecptr);
@@ -169,7 +169,7 @@ void vpic_pending_intr(struct acrn_vm *vm, uint32_t *vecptr);
* @param[in] vm Pointer to target VM
* @param[in] vector Target virtual interrupt vector
*
* @return void
* @return None
*
* @pre vm != NULL
*/

4
hypervisor/include/arch/x86/ioreq.h
View File

@@ -292,7 +292,7 @@ int32_t acrn_insert_request_wait(struct acrn_vcpu *vcpu, const struct io_request
*
* @param vm The VM whose IO requests to be reset
*
* @return N/A
* @return None
*/
void reset_vm_ioreqs(struct acrn_vm *vm);
@@ -301,7 +301,7 @@ void reset_vm_ioreqs(struct acrn_vm *vm);
*
* @param pcpu_id The physical cpu id of vcpu whose IO request to be checked
*
* @return N/A
* @return None
*/
void handle_complete_ioreq(uint16_t pcpu_id);

14
hypervisor/include/arch/x86/irq.h
View File

@@ -150,7 +150,7 @@ int vcpu_queue_exception(struct acrn_vcpu *vcpu, uint32_t vector, uint32_t err_c
*
* @param[in] vcpu Pointer to vCPU.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -161,7 +161,7 @@ void vcpu_inject_extint(struct acrn_vcpu *vcpu);
*
* @param[in] vcpu Pointer to vCPU.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -173,7 +173,7 @@ void vcpu_inject_nmi(struct acrn_vcpu *vcpu);
* @param[in] vcpu Pointer to vCPU.
* @param[in] err_code Error Code to be injected.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -186,7 +186,7 @@ void vcpu_inject_gp(struct acrn_vcpu *vcpu, uint32_t err_code);
* @param[in] addr Address that result in PF.
* @param[in] err_code Error Code to be injected.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -197,7 +197,7 @@ void vcpu_inject_pf(struct acrn_vcpu *vcpu, uint64_t addr, uint32_t err_code);
*
* @param[in] vcpu Pointer to vCPU.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -208,7 +208,7 @@ void vcpu_inject_ud(struct acrn_vcpu *vcpu);
*
* @param[in] vcpu Pointer to vCPU.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/
@@ -219,7 +219,7 @@ void vcpu_inject_ac(struct acrn_vcpu *vcpu);
*
* @param[in] vcpu Pointer to vCPU.
*
* @return void
* @return None
*
* @pre vcpu != NULL
*/