From 45d8190f3cd5eeea1c58ba5aa286d3b5c9e180bf Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 5 Apr 2018 16:18:55 -0700 Subject: [PATCH] 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 --- include/common/hypercall.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/common/hypercall.h b/include/common/hypercall.h index ec9a49faa..c1f4b48c0 100644 --- a/include/common/hypercall.h +++ b/include/common/hypercall.h @@ -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.