From: "Rebecca Cran" <quic_rcran@quicinc.com>
To: <devel@edk2.groups.io>, <pierre.gondois@arm.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>,
Leif Lindholm <quic_llindhol@quicinc.com>,
Ard Biesheuvel <ardb+tianocore@kernel.org>,
Rebecca Cran <rebecca@bsdio.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <gaoliming@byosoft.com.cn>,
"Jiewen Yao" <jiewen.yao@intel.com>,
Jian J Wang <jian.j.wang@intel.com>
Subject: Re: [edk2-devel] [PATCH v5 03/21] ArmPkg/ArmMonitorLib: Add ArmMonitorLib
Date: Tue, 27 Sep 2022 12:10:34 -0700 [thread overview]
Message-ID: <7ab9ddab-afb1-d950-7f67-21d928e3962f@quicinc.com> (raw)
In-Reply-To: <20220919192207.637786-4-Pierre.Gondois@arm.com>
On 9/19/2022 12:21 PM, PierreGondois wrote:
> +/** Monitor call.
> +
> + An HyperVisor Call (HVC) or System Monitor Call (SMC) will be issued
> + depending on the default conduit. PcdMonitorConduitHvc determines the type
> + of the call: if true, do an HVC.
> +
> + @param [in, out] Args Arguments for the HVC/SMC.
> +**/
> +VOID
> +EFIAPI
> +ArmMonitorCall (
> + IN OUT ARM_MONITOR_ARGS *Args
> + )
Doxygen specifies that there shouldn't be a space between "in" and "out"
From https://doxygen.nl/manual/docblocks.html
"For functions one can use the @param command to document the parameters
and then use [in], [out], [in,out] to document the direction."
Clang can warn about this mismatch when the various documentation
commands are used: https://clang.llvm.org/docs/DiagnosticsReference.html
--
Rebecca Cran
next prev parent reply other threads:[~2022-09-27 19:15 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-19 19:21 [PATCH v5 00/21] Add Raw algorithm support using Arm FW-TRNG interface PierreGondois
2022-09-19 19:21 ` [PATCH v5 01/21] ArmPkg: PCD to select conduit for monitor calls PierreGondois
2022-09-27 18:59 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 02/21] ArmPkg/ArmMonitorLib: Definition for ArmMonitorLib library class PierreGondois
2022-09-19 19:21 ` [PATCH v5 03/21] ArmPkg/ArmMonitorLib: Add ArmMonitorLib PierreGondois
2022-09-27 18:51 ` Leif Lindholm
2022-09-27 19:00 ` [edk2-devel] " Rebecca Cran
2022-09-27 19:10 ` Rebecca Cran [this message]
2022-09-19 19:21 ` [PATCH v5 04/21] ArmPkg/ArmHvcNullLib: Add NULL instance of ArmHvcLib PierreGondois
2022-09-27 18:55 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 05/21] MdePkg/TrngLib: Definition for TRNG library class interface PierreGondois
2022-09-27 19:00 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 06/21] MdePkg/TrngLib: Add NULL instance of TRNG Library PierreGondois
2022-09-27 19:02 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 07/21] ArmPkg: Add FID definitions for Firmware TRNG PierreGondois
2022-09-27 19:04 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 08/21] ArmPkg/TrngLib: Add Arm Firmware TRNG library PierreGondois
2022-09-19 19:21 ` [PATCH v5 09/21] MdePkg/BaseRngLib: Rename ArmReadIdIsar0() to ArmGetFeatRng() PierreGondois
2022-09-27 21:44 ` [edk2-devel] " Rebecca Cran
2022-09-28 17:10 ` Leif Lindholm
2022-09-29 16:21 ` PierreGondois
2022-09-29 17:09 ` Leif Lindholm
2022-09-19 19:21 ` [PATCH v5 10/21] ArmPkg/ArmLib: Add ArmReadIdIsar0() helper PierreGondois
2022-09-19 19:21 ` [PATCH v5 11/21] ArmPkg/ArmLib: Add ArmHasRngExt() PierreGondois
2022-09-19 19:21 ` [PATCH v5 12/21] SecurityPkg/RngDxe: Rename RdRandGenerateEntropy to generic name PierreGondois
2022-09-19 19:21 ` [PATCH v5 13/21] SecurityPkg/RngDxe: Replace Pcd with Sp80090Ctr256Guid PierreGondois
2022-09-19 19:22 ` [PATCH v5 14/21] SecurityPkg/RngDxe: Remove ArchGetSupportedRngAlgorithms() PierreGondois
2022-09-19 19:22 ` [PATCH v5 15/21] SecurityPkg/RngDxe: Documentation/include/parameter cleanup PierreGondois
2022-09-19 19:22 ` [PATCH v5 16/21] SecurityPkg/RngDxe: Check before advertising Cpu Rng algo PierreGondois
2022-09-19 19:22 ` [PATCH v5 17/21] SecurityPkg/RngDxe: Add AArch64 RawAlgorithm support through TrngLib PierreGondois
2022-09-19 19:22 ` [PATCH v5 18/21] SecurityPkg/RngDxe: Add debug warning for NULL PcdCpuRngSupportedAlgorithm PierreGondois
2022-09-19 19:22 ` [PATCH v5 19/21] SecurityPkg/RngDxe: Rename AArch64/RngDxe.c PierreGondois
2022-09-19 19:22 ` [PATCH v5 20/21] SecurityPkg/RngDxe: Add Arm support of RngDxe PierreGondois
2022-09-19 19:22 ` [PATCH v5 21/21] ArmVirtPkg: Kvmtool: Add RNG support using FW-TRNG interface PierreGondois
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=7ab9ddab-afb1-d950-7f67-21d928e3962f@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