X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FMetronome.h;h=2383c73046446f020639a49a11c11a0222f40b1e;hb=f754f721bf10508ca15c5c9243caa39c765662cf;hp=edc4927d35c8402ae7a1dafd04011104d00f8252;hpb=4ca9b6c4e7dbbcf94f21b54f41f761cefc6b1086;p=mirror_edk2.git

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