Skip to content

Commit 3726a0f

Browse files
dbkinderjren1
authored andcommitted
doc: fix hypercall API doxygen errors
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>
1 parent b11460f commit 3726a0f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

hypervisor/include/common/hypercall.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ int64_t hcall_setup_sbuf(struct vm *vm, uint64_t param);
329329
/**
330330
* @brief Switch VCPU state between Normal/Secure World.
331331
*
332-
* @param VCPU Pointer to VCPU data structure
332+
* @param vcpu Pointer to VCPU data structure
333333
*
334334
* @return 0 on success, non-zero on error.
335335
*/
@@ -338,8 +338,8 @@ int64_t hcall_world_switch(struct vcpu *vcpu);
338338
/**
339339
* @brief Initialize environment for Trusty-OS on a VCPU.
340340
*
341-
* @param VCPU Pointer to VCPU data structure
342-
* @param param's guest physical address. This gpa points to
341+
* @param vcpu Pointer to VCPU data structure
342+
* @param param guest physical address. This gpa points to
343343
* struct trusty_boot_param
344344
*
345345
* @return 0 on success, non-zero on error.

0 commit comments

Comments
 (0)