Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / MdePkg / Include / Protocol / Metronome.h

diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h
index edc4927d35c8402ae7a1dafd04011104d00f8252..bef64a5963d6ac8ece342070fee7c7b0adc565b6 100644 (file)
--- a/MdePkg/Include/Protocol/Metronome.h
+++ b/MdePkg/Include/Protocol/Metronome.h
@@ -17,15 +17,15 @@
 #ifndef __ARCH_PROTOCOL_METRONOME_H__\r
 #define __ARCH_PROTOCOL_METRONOME_H__\r
 \r
-//\r
-// Global ID for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Metronome Architectural Protocol\r
+///\r
 #define EFI_METRONOME_ARCH_PROTOCOL_GUID \\r
   { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
 \r
-//\r
-// Declare forward reference for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Metronome Architectural Protocol\r
+///\r
 typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;\r
 \r
 /**\r
@@ -33,7 +33,7 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;
   TickNumber from a known time source in the platform.  If TickNumber of \r
   ticks are detected, then EFI_SUCCESS is returned.  The actual time passed \r
   between entry of this function and the first tick is between 0 and \r
-  TickPeriod 100 nS units.  If you want to guarantee that at least TickPeriod \r
+  TickPeriod 100 nS units.  To guarantee that at least TickPeriod \r
   time has elapsed, wait for two ticks.  This function waits for a hardware \r
   event to determine when a tick occurs.  It is possible for interrupt \r
   processing, or exception processing to interrupt the execution of the \r
@@ -57,34 +57,21 @@ EFI_STATUS
    IN UINT32                        TickNumber\r
   );\r
 \r
-//\r
-//\r
-\r
-/**\r
-  Interface stucture for the Metronome Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  This protocol provides access to a known time source in the platform to the\r
-  core.  The core uses this known time source to produce core services that \r
-  require calibrated delays.  \r
-\r
-  @param WaitForTick\r
-  Waits for a specified number of ticks from a known time source \r
-  in the platform.  The actual time passed between entry of this \r
-  function and the first tick is between 0 and TickPeriod 100 nS \r
-  units.  If you want to guarantee that at least TickPeriod time \r
-  has elapsed, wait for two ticks.\r
-\r
-  @param TickPeriod\r
-  The period of platform's known time source in 100 nS units.  \r
-  This value on any platform must be at least 10 uS, and must not \r
-  exceed 200 uS.  The value in this field is a constant that must \r
-  not be modified after the Metronome architectural protocol is \r
-  installed.  All consumers must treat this as a read-only field.\r
-\r
-**/\r
+///\r
+/// This protocol provides access to a known time source in the platform to the\r
+/// core.  The core uses this known time source to produce core services that \r
+/// require calibrated delays.  \r
+///\r
 struct _EFI_METRONOME_ARCH_PROTOCOL {\r
   EFI_METRONOME_WAIT_FOR_TICK  WaitForTick;\r
+  \r
+  ///\r
+  /// The period of platform's known time source in 100 nS units.  \r
+  /// This value on any platform must be at least 10 uS, and must not \r
+  /// exceed 200 uS.  The value in this field is a constant that must \r
+  /// not be modified after the Metronome architectural protocol is \r
+  /// installed.  All consumers must treat this as a read-only field.  \r
+  ///\r
   UINT32                       TickPeriod;\r
 };\r
 \r