Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h
index 8e31a36bc5ec4d2db51be9265d94bd731c7cb268..3dc1a587ce304e6c9b452796af35f7f43250ebf2 100644 (file)
--- a/MdePkg/Include/Protocol/WatchdogTimer.h
+++ b/MdePkg/Include/Protocol/WatchdogTimer.h
@@ -1,9 +1,9 @@
 /** @file\r
-  Watchdog Timer Architectural Protocol as defined in the DXE CIS\r
+  Watchdog Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
   Used to provide system watchdog timer 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
@@ -11,26 +11,20 @@
 \r
   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:  WatchdogTimer.h\r
-\r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 #define __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 \r
-//\r
-// Global ID for the Watchdog Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Watchdog Timer Architectural Protocol\r
+///\r
 #define EFI_WATCHDOG_TIMER_ARCH_PROTOCOL_GUID \\r
   { 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
 typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;\r
 \r
 /**\r
@@ -46,7 +40,7 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOC
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_WATCHDOG_TIMER_NOTIFY) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_NOTIFY)(\r
   IN UINT64  Time\r
   );\r
 \r
@@ -76,7 +70,7 @@ VOID
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER)(\r
   IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   IN EFI_WATCHDOG_TIMER_NOTIFY         NotifyFunction\r
   );\r
@@ -99,7 +93,7 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD)(\r
   IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   IN UINT64                            TimerPeriod\r
   );\r
@@ -121,7 +115,7 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD)(\r
   IN  EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   OUT UINT64                            *TimerPeriod\r
   );\r