Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h
index c4a1f71925fd74e876436f1ad4bca201241c10c4..58a9c5ff365234fd8c5716fb55295ad9d600cbe0 100644 (file)
--- a/MdePkg/Include/Protocol/Metronome.h
+++ b/MdePkg/Include/Protocol/Metronome.h
@@ -1,9 +1,9 @@
 /** @file\r
-  Metronome Architectural Protocol as defined in DXE CIS\r
+  Metronome Architectural Protocol as defined in PI SPEC VOLUME 2 DXE\r
 \r
   This code abstracts the DXE core to provide delay services.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -12,25 +12,20 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  Metronome.h\r
-\r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #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
@@ -57,14 +52,11 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_METRONOME_WAIT_FOR_TICK) (\r
+(EFIAPI *EFI_METRONOME_WAIT_FOR_TICK)(\r
    IN EFI_METRONOME_ARCH_PROTOCOL   *This,\r
    IN UINT32                        TickNumber\r
   );\r
 \r
-//\r
-//\r
-\r
 /**\r
   Interface stucture for the Metronome Architectural Protocol.\r
 \r
@@ -79,17 +71,17 @@ EFI_STATUS
   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
 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