MdeModulePkg: Fix coding style issues in file/function comments
authorDandan Bi <dandan.bi@intel.com>
Fri, 16 Mar 2018 03:30:53 +0000 (11:30 +0800)
committerStar Zeng <star.zeng@intel.com>
Mon, 19 Mar 2018 01:57:22 +0000 (09:57 +0800)
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
MdeModulePkg/Include/Protocol/BootLogo2.h
MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.inf
MdeModulePkg/Library/BaseBmpSupportLib/BaseBmpSupportLib.uni
MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmp.c
MdeModulePkg/Universal/EsrtFmpDxe/EsrtFmpDebugPrint.c

index 583a253..905197a 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
 Boot Logo 2 Protocol is used to convey information of Logo dispayed during boot.\r
 \r
 The Boot Logo 2 Protocol is a replacement for the Boot Logo Protocol.  If a\r
index 02c3fae..2ee2e7e 100644 (file)
@@ -1,4 +1,5 @@
 ## @file\r
+# Base library to support BMP graphics image conversion.\r
 #\r
 # Provides services to convert a BMP graphics image to a GOP BLT buffer and\r
 # from a GOP BLT buffer to a BMP graphics image.\r
index f24e2d2..373d1e7 100644 (file)
@@ -1,4 +1,5 @@
 // /** @file\r
+// Base library to support BMP graphics image conversion.\r
 //\r
 // Provides services to convert a BMP graphics image to a GOP BLT buffer and\r
 // from a GOP BLT buffer to a BMP graphics image.\r
index b98430e..3da4a62 100644 (file)
 #include <Guid/EventGroup.h>\r
 #include <Guid/SystemResourceTable.h>\r
 \r
-//\r
-// Print ESRT to debug console\r
-//\r
+/**\r
+ Print ESRT to debug console.\r
+\r
+ @param[in]  Table   Pointer to the ESRT table.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 PrintTable (\r
@@ -132,6 +135,9 @@ IsSystemFmp (
   given a FMP descriptor.  If the guid is already in the ESRT it\r
   will be ignored.  The ESRT will grow if it does not have enough room.\r
 \r
+  @param[in]  FmpImageInfoBuf    Pointer to the EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
+  @param[in]  FmpVersion         FMP Version.\r
+\r
   @return  Status code.\r
 \r
 **/\r
index b4e5135..8e60385 100644 (file)
@@ -34,7 +34,7 @@
 #include <Guid/SystemResourceTable.h>\r
 \r
 /**\r
-  Function to print a single ESRT Entry (ESRE) to the debug console\r
+  Function to print a single ESRT Entry (ESRE) to the debug console.\r
 \r
   Print Format:\r
   | 00000000-0000-0000-0000-000000000000 | SSSSSSSSSSSS | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 |\r
@@ -101,7 +101,7 @@ PrintOutEsrtEntry (
 }\r
 \r
 /**\r
-  Function to print the ESRT table to the debug console\r
+  Function to print the ESRT table to the debug console.\r
 \r
   @param[in]  Table  - Pointer to the ESRT table\r
 **/\r