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
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#94439): https://edk2.groups.io/g/devel/message/94439
Mute This Topic: https://groups.io/mt/93788866/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
