From: "Rebecca Cran" <quic_rcran@quicinc.com>
To: <devel@edk2.groups.io>, Leif Lindholm <quic_llindhol@quicinc.com>,
"Sami Mujawar" <sami.mujawar@arm.com>,
Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Rebecca Cran <rebecca@quicinc.com>
Subject: [PATCH 1/2] ArmPkg: Fix incorrect parameter list in doxygen comments
Date: Thu, 1 Dec 2022 17:34:56 -0700 [thread overview]
Message-ID: <20221202003457.81701-2-rebecca@quicinc.com> (raw)
In-Reply-To: <20221202003457.81701-1-rebecca@quicinc.com>
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
next prev parent reply other threads:[~2022-12-02 0:35 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-02 0:34 [PATCH 0/2] ArmPkg: Improve doxygen comments in ArmExceptionLib Rebecca Cran
2022-12-02 0:34 ` Rebecca Cran [this message]
2022-12-02 0:34 ` [PATCH 2/2] ArmPkg: Improve formatting of docs in ArmExceptionLib/ArmExceptionLib.c Rebecca Cran
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221202003457.81701-2-rebecca@quicinc.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox