MdeModulePkg/Include/Protocol/BootLogo2.h | 2 +- MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf | 1 + MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c | 12 +++++++++--- MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c | 4 ++-- 4 files changed, 13 insertions(+), 6 deletions(-)
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
MdeModulePkg/Include/Protocol/BootLogo2.h | 2 +-
MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf | 1 +
MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c | 12 +++++++++---
MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c | 4 ++--
4 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/MdeModulePkg/Include/Protocol/BootLogo2.h b/MdeModulePkg/Include/Protocol/BootLogo2.h
index 583a253..905197a 100644
--- a/MdeModulePkg/Include/Protocol/BootLogo2.h
+++ b/MdeModulePkg/Include/Protocol/BootLogo2.h
@@ -1,6 +1,6 @@
-/**
+/** @file
Boot Logo 2 Protocol is used to convey information of Logo dispayed during boot.
The Boot Logo 2 Protocol is a replacement for the Boot Logo Protocol. If a
platform produces both the Boot Logo 2 Protocol and the Boot Logo Protocol
then the Boot Logo 2 Protocol must be used instead of the Boot Logo Protocol.
diff --git a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
index 02c3fae..2ee2e7e 100644
--- a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
+++ b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
@@ -1,6 +1,7 @@
## @file
+# Base library to support BMP graphics image conversion.
#
# Provides services to convert a BMP graphics image to a GOP BLT buffer and
# from a GOP BLT buffer to a BMP graphics image.
#
# Copyright (c) 2017, Microsoft Corporation
diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
index b98430e..3da4a62 100644
--- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
+++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
@@ -36,13 +36,16 @@
#include <Library/UefiLib.h>
#include <Protocol/FirmwareManagement.h>
#include <Guid/EventGroup.h>
#include <Guid/SystemResourceTable.h>
-//
-// Print ESRT to debug console
-//
+/**
+ Print ESRT to debug console.
+
+ @param[in] Table Pointer to the ESRT table.
+
+**/
VOID
EFIAPI
PrintTable (
IN EFI_SYSTEM_RESOURCE_TABLE *Table
);
@@ -130,10 +133,13 @@ IsSystemFmp (
/**
Function to create a single ESRT Entry and add it to the ESRT
given a FMP descriptor. If the guid is already in the ESRT it
will be ignored. The ESRT will grow if it does not have enough room.
+ @param[in] FmpImageInfoBuf Pointer to the EFI_FIRMWARE_IMAGE_DESCRIPTOR.
+ @param[in] FmpVersion FMP Version.
+
@return Status code.
**/
EFI_STATUS
EFIAPI
diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
index b4e5135..8e60385 100644
--- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
+++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
@@ -32,11 +32,11 @@
#include <Library/DebugLib.h>
#include <Protocol/FirmwareManagement.h>
#include <Guid/SystemResourceTable.h>
/**
- Function to print a single ESRT Entry (ESRE) to the debug console
+ Function to print a single ESRT Entry (ESRE) to the debug console.
Print Format:
| 00000000-0000-0000-0000-000000000000 | SSSSSSSSSSSS | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 |
@param[in] Entry - Pointer to an ESRE entry
@@ -99,11 +99,11 @@ PrintOutEsrtEntry (
return EFI_SUCCESS;
}
/**
- Function to print the ESRT table to the debug console
+ Function to print the ESRT table to the debug console.
@param[in] Table - Pointer to the ESRT table
**/
VOID
EFIAPI
--
1.9.5.msysgit.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Only one minor comment. Do you think BaseBmpSupportLib.uni should be also updated accordingly based on the change in BaseBmpSupportLib? With that covered, Reviewed-by: Star Zeng <star.zeng@intel.com>. Thanks, Star -----Original Message----- From: Bi, Dandan Sent: Friday, March 16, 2018 1:26 PM To: edk2-devel@lists.01.org Cc: Zeng, Star <star.zeng@intel.com> Subject: [patch] MdeModulePkg: Fix coding style issues in file/function comments Cc: Star Zeng <star.zeng@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Dandan Bi <dandan.bi@intel.com> --- MdeModulePkg/Include/Protocol/BootLogo2.h | 2 +- MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf | 1 + MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c | 12 +++++++++--- MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c | 4 ++-- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/MdeModulePkg/Include/Protocol/BootLogo2.h b/MdeModulePkg/Include/Protocol/BootLogo2.h index 583a253..905197a 100644 --- a/MdeModulePkg/Include/Protocol/BootLogo2.h +++ b/MdeModulePkg/Include/Protocol/BootLogo2.h @@ -1,6 +1,6 @@ -/** +/** @file Boot Logo 2 Protocol is used to convey information of Logo dispayed during boot. The Boot Logo 2 Protocol is a replacement for the Boot Logo Protocol. If a platform produces both the Boot Logo 2 Protocol and the Boot Logo Protocol then the Boot Logo 2 Protocol must be used instead of the Boot Logo Protocol. diff --git a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf index 02c3fae..2ee2e7e 100644 --- a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf +++ b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf @@ -1,6 +1,7 @@ ## @file +# Base library to support BMP graphics image conversion. # # Provides services to convert a BMP graphics image to a GOP BLT buffer and # from a GOP BLT buffer to a BMP graphics image. # # Copyright (c) 2017, Microsoft Corporation diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c index b98430e..3da4a62 100644 --- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c +++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c @@ -36,13 +36,16 @@ #include <Library/UefiLib.h> #include <Protocol/FirmwareManagement.h> #include <Guid/EventGroup.h> #include <Guid/SystemResourceTable.h> -// -// Print ESRT to debug console -// +/** + Print ESRT to debug console. + + @param[in] Table Pointer to the ESRT table. + +**/ VOID EFIAPI PrintTable ( IN EFI_SYSTEM_RESOURCE_TABLE *Table ); @@ -130,10 +133,13 @@ IsSystemFmp ( /** Function to create a single ESRT Entry and add it to the ESRT given a FMP descriptor. If the guid is already in the ESRT it will be ignored. The ESRT will grow if it does not have enough room. + @param[in] FmpImageInfoBuf Pointer to the EFI_FIRMWARE_IMAGE_DESCRIPTOR. + @param[in] FmpVersion FMP Version. + @return Status code. **/ EFI_STATUS EFIAPI diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c index b4e5135..8e60385 100644 --- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c +++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c @@ -32,11 +32,11 @@ #include <Library/DebugLib.h> #include <Protocol/FirmwareManagement.h> #include <Guid/SystemResourceTable.h> /** - Function to print a single ESRT Entry (ESRE) to the debug console + Function to print a single ESRT Entry (ESRE) to the debug console. Print Format: | 00000000-0000-0000-0000-000000000000 | SSSSSSSSSSSS | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 | @param[in] Entry - Pointer to an ESRE entry @@ -99,11 +99,11 @@ PrintOutEsrtEntry ( return EFI_SUCCESS; } /** - Function to print the ESRT table to the debug console + Function to print the ESRT table to the debug console. @param[in] Table - Pointer to the ESRT table **/ VOID EFIAPI -- 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
© 2016 - 2024 Red Hat, Inc.