summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDandan Bi <dandan.bi@intel.com>2018-03-16 11:30:53 +0800
committerStar Zeng <star.zeng@intel.com>2018-07-09 10:51:34 +0800
commit05d48dace87176c8abf32124c8246936c21075f5 (patch)
treeb479fb31323ef4b1e4ff513244b306b2abfd46f0
parent63bcec2f018d0389d9ad8859fe98718f6be52cfa (diff)
downloadedk2-05d48dace87176c8abf32124c8246936c21075f5.tar.gz
edk2-05d48dace87176c8abf32124c8246936c21075f5.tar.bz2
edk2-05d48dace87176c8abf32124c8246936c21075f5.zip
MdeModulePkg: Fix coding style issues in file/function comments
Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Dandan Bi <dandan.bi@intel.com> Reviewed-by: Star Zeng <star.zeng@intel.com> (cherry picked from commit ae38c9765a27264ecea03c6430b956b74a427213)
-rw-r--r--MdeModulePkg/Include/Protocol/BootLogo2.h2
-rw-r--r--MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf1
-rw-r--r--MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni1
-rw-r--r--MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c12
-rw-r--r--MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c4
5 files changed, 14 insertions, 6 deletions
diff --git a/MdeModulePkg/Include/Protocol/BootLogo2.h b/MdeModulePkg/Include/Protocol/BootLogo2.h
index 583a253ea7..905197a07a 100644
--- a/MdeModulePkg/Include/Protocol/BootLogo2.h
+++ b/MdeModulePkg/Include/Protocol/BootLogo2.h
@@ -1,4 +1,4 @@
-/**
+/** @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
diff --git a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
index 02c3fae0b4..2ee2e7e229 100644
--- a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
+++ b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
@@ -1,4 +1,5 @@
## @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.
diff --git a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni
index f24e2d246f..373d1e7e38 100644
--- a/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni
+++ b/MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni
@@ -1,4 +1,5 @@
// /** @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.
diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
index b98430edbf..3da4a62fb1 100644
--- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
+++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
@@ -38,9 +38,12 @@
#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 (
@@ -132,6 +135,9 @@ IsSystemFmp (
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.
**/
diff --git a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
index b4e5135e05..8e60385099 100644
--- a/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
+++ b/MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c
@@ -34,7 +34,7 @@
#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 |
@@ -101,7 +101,7 @@ PrintOutEsrtEntry (
}
/**
- 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
**/