Clean up GenericBdsLib library Instance.

[mirror_edk2.git] / MdeModulePkg / Library / GenericBdsLib / Performance.c

diff --git a/MdeModulePkg/Library/GenericBdsLib/Performance.c b/MdeModulePkg/Library/GenericBdsLib/Performance.c
index 29547a3b4249475a73d03343ee250b16404cd24b..3b58351495278eab050b5aade77d90a3bba9012d 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/Performance.c
+++ b/MdeModulePkg/Library/GenericBdsLib/Performance.c
@@ -19,21 +19,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 STATIC PERF_HEADER               mPerfHeader;\r
 STATIC PERF_DATA                 mPerfData;\r
 \r
-STATIC\r
+/**\r
+  Get the short verion of PDB file name to be\r
+  used in performance data logging.\r
+\r
+  @param PdbFileName     The long PDB file name.\r
+  @param GaugeString     The output string to be logged by performance logger.\r
+\r
+**/\r
 VOID\r
 GetShortPdbFileName (\r
-  CHAR8  *PdbFileName,\r
-  CHAR8  *GaugeString\r
+  IN  CONST CHAR8  *PdbFileName,\r
+  OUT       CHAR8  *GaugeString\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
 {\r
   UINTN Index;\r
   UINTN Index1;\r
@@ -72,7 +70,15 @@ Returns:
   return ;\r
 }\r
 \r
-STATIC\r
+/**\r
+  Get the name from the Driver handle, which can be a handle with\r
+  EFI_LOADED_IMAGE_PROTOCOL or EFI_DRIVER_BINDING_PROTOCOL installed.\r
+  This name can be used in performance data logging.\r
+\r
+  @param Handle          Driver handle.\r
+  @param GaugeString     The output string to be logged by performance logger.\r
+\r
+**/\r
 VOID\r
 GetNameFromHandle (\r
   IN  EFI_HANDLE     Handle,\r
@@ -126,25 +132,16 @@ GetNameFromHandle (
   return ;\r
 }\r
 \r
+/**\r
+\r
+  Allocates a block of memory and writes performance data of booting into it.\r
+  OS can processing these record.\r
+  \r
+**/\r
 VOID\r
 WriteBootToOsPerformanceData (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  \r
-  Allocates a block of memory and writes performance data of booting to OS into it.\r
-\r
-Arguments:\r
-  \r
-  None\r
-  \r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
 {\r
   EFI_STATUS                Status;\r
   EFI_PHYSICAL_ADDRESS      AcpiLowMemoryBase;\r