[edk2-devel] [PATCH edk2-platforms v1 09/10] Platform/ARM: Fix Ecc error 9005

PierreGondois posted 10 patches 4 years, 2 months ago
[edk2-devel] [PATCH edk2-platforms v1 09/10] Platform/ARM: Fix Ecc error 9005
Posted by PierreGondois 4 years, 2 months ago
From: Pierre Gondois <Pierre.Gondois@arm.com>

This patch fixes the following Ecc reported error:
Only Doxygen commands '@bug', '@todo', '@example',
'@file', '@attention', '@param', '@post', '@pre',
'@retval', '@return', '@sa', '@since', '@test',
'@note', '@par', '@endcode', '@code', '@{', '@}'
are allowed to mark the code

Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
 .../ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c b/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
index 54add33b8912..4f6e0c5c44b8 100644
--- a/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
+++ b/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
@@ -106,7 +106,7 @@ STATIC CONST CHAR16 mAcpiAddrSpaceTypeStr[][4] = {

   @param [out] Count  Return the count of root bridge instances.

-  @returns All the root bridge instances in an array.
+  @return  All the root bridge instances in an array.
            The array should be passed into PciHostBridgeFreeRootBridges()
            when it's not used.
 **/
--
2.25.1


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


Re: [edk2-devel] [PATCH edk2-platforms v1 09/10] Platform/ARM: Fix Ecc error 9005
Posted by Sami Mujawar 4 years, 1 month ago
Hi Pierre,

Thank you for this patch.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar


On 24/11/2021 04:23 PM, Pierre.Gondois@arm.com wrote:
> From: Pierre Gondois <Pierre.Gondois@arm.com>
>
> This patch fixes the following Ecc reported error:
> Only Doxygen commands '@bug', '@todo', '@example',
> '@file', '@attention', '@param', '@post', '@pre',
> '@retval', '@return', '@sa', '@since', '@test',
> '@note', '@par', '@endcode', '@code', '@{', '@}'
> are allowed to mark the code
>
> Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
> ---
>   .../ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c   | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c b/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
> index 54add33b8912..4f6e0c5c44b8 100644
> --- a/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
> +++ b/Platform/ARM/VExpressPkg/Library/ArmVExpressPciHostBridgeLib/ArmVExpressPciHostBridgeLib.c
> @@ -106,7 +106,7 @@ STATIC CONST CHAR16 mAcpiAddrSpaceTypeStr[][4] = {
>
>     @param [out] Count  Return the count of root bridge instances.
>
> -  @returns All the root bridge instances in an array.
> +  @return  All the root bridge instances in an array.
>              The array should be passed into PciHostBridgeFreeRootBridges()
>              when it's not used.
>   **/
> --
> 2.25.1

IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.


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