Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Guid / Performance.h

diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index 14c7c83d51cec44e4ea4fbf53b94521c24f0746e..b59fe8104059e25f4384042c6fb4cf75064282a2 100644 (file)
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -1,6 +1,8 @@
 /** @file\r
-  This file defines performance related definitions: the format of performance\r
-  GUID HOB, performance protocol interfaces and performance variable format.  \r
+  This file defines performance-related definitions, including the format of:\r
+  * performance GUID HOB\r
+  * performance protocol interfaces\r
+  * performance variables.  \r
 \r
 Copyright (c) 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -94,7 +96,7 @@ typedef struct {
 // The header must be aligned at 8 bytes\r
 //\r
 typedef struct {\r
-  UINT32                NumberOfEntries; ///> The number of all performance guage entries\r
+  UINT32                NumberOfEntries; ///> The number of all performance gauge entries\r
   UINT32                Reserved;\r
 } GAUGE_DATA_HEADER;\r
 \r
@@ -102,9 +104,8 @@ typedef struct {
   Adds a record at the end of the performance measurement log\r
   that records the start time of a performance measurement.\r
 \r
-  Adds a record to the end of the performance measurement log\r
-  that contains the Handle, Token, and Module.\r
-  The end time of the new record must be set to zero.\r
+  The added record contains the Handle, Token, and Module.\r
+  The end time of the new record is not recorded, so it is set to zero.\r
   If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.\r
   If TimeStamp is zero, the start time in the record is filled in with the value\r
   read from the current time stamp.\r
@@ -172,13 +173,11 @@ EFI_STATUS
 \r
   @param  LogEntryKey             The key for the previous performance measurement log entry.\r
                                   If 0, then the first performance measurement log entry is retrieved.\r
-  @param  GaugeDataEntry          The indirect pointer to the gauge data entry specified by LogEntryKey\r
-                                  if the retrieval is successful.\r
-\r
+  @param  GaugeDataEntry          Out parameter for the indirect pointer to the gauge data entry specified by LogEntryKey.\r
+                                  \r
   @retval EFI_SUCCESS             The GuageDataEntry is successfully found based on LogEntryKey.\r
-  @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).\r
-  @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).\r
-  @retval EFI_INVALIDE_PARAMETER  GaugeDataEntry is NULL.\r
+  @retval EFI_NOT_FOUND           There is no entry after the measurement referred to by LogEntryKey.\r
+  @retval EFI_INVALID_PARAMETER   The LogEntryKey is not a valid entry, or GaugeDataEntry is NULL.\r
 \r
 **/\r
 typedef\r