[edk2-devel] [PATCH 1/2] ArmPkg: Fix incorrect parameter list in doxygen comments

Rebecca Cran posted 2 patches 3 years, 2 months ago
[edk2-devel] [PATCH 1/2] ArmPkg: Fix incorrect parameter list in doxygen comments
Posted by Rebecca Cran 3 years, 2 months ago
Fix the doxygen comments for CopyExceptionHandlers by removing the
nonexistant "VectorInfo" parameter and replacing it with "BaseAddress".

Fix the doxygen comments for RegisterCpuInterruptHandler by removing
the nonexistant parameter "This".

Signed-off-by: Rebecca Cran <rebecca@quicinc.com>
---
 ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c b/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c
index a521c33f3281..b20472008b3f 100644
--- a/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c
+++ b/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c
@@ -137,7 +137,7 @@ persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.
 If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
 If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.
 
-@param[in]  VectorInfo    Pointer to reserved vector list.
+@param[in]  BaseAddress    Address to copy exception handlers to.
 
 @retval EFI_SUCCESS           CPU Exception Entries have been successfully initialized
 with default exception handlers.
@@ -242,7 +242,6 @@ RegisterCpuInterruptHandler (
 /**
 Register exception handler.
 
-@param  This                  A pointer to the SMM_CPU_SERVICE_PROTOCOL instance.
 @param  ExceptionType         Defines which interrupt or exception to hook. Type EFI_EXCEPTION_TYPE and
 the valid values for this parameter are defined in EFI_DEBUG_SUPPORT_PROTOCOL
 of the UEFI 2.0 specification.
-- 
2.30.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#96877): https://edk2.groups.io/g/devel/message/96877
Mute This Topic: https://groups.io/mt/95397087/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-