github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-29 14:37:36 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix hypercall API doxygen errors

Browse Source 
Documentation for parameters must match exactly in spelling and case.
Parameter named "vcpu" was incorrectly documented as "VCPU", and
parameter named "param" was documented as "param's".

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-04-05 16:18:55 -07:00 committed by Jack Ren
parent b11460f7f6
commit 3726a0f7a5
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
hypervisor/include/common/hypercall.h
View File

@ -329,7 +329,7 @@ int64_t hcall_setup_sbuf(struct vm *vm, uint64_t param);
/**
* @brief Switch VCPU state between Normal/Secure World.
*
* @param VCPU Pointer to VCPU data structure
* @param vcpu Pointer to VCPU data structure
*
* @return 0 on success, non-zero on error.
*/
@ -338,8 +338,8 @@ int64_t hcall_world_switch(struct vcpu *vcpu);
/**
* @brief Initialize environment for Trusty-OS on a VCPU.
*
* @param VCPU Pointer to VCPU data structure
* @param param's guest physical address. This gpa points to
* @param vcpu Pointer to VCPU data structure
* @param param guest physical address. This gpa points to
* struct trusty_boot_param
*
* @return 0 on success, non-zero on error.