]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Metronome.h
Update comments for Protocol definitions to match UEFI spec.
[mirror_edk2.git] / MdePkg / Include / Protocol / Metronome.h
index 58a9c5ff365234fd8c5716fb55295ad9d600cbe0..2383c73046446f020639a49a11c11a0222f40b1e 100644 (file)
@@ -57,21 +57,11 @@ EFI_STATUS
    IN UINT32                        TickNumber\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
+///\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