Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Dxe / ArchProtocol / WatchdogTimer.h

diff --git a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h
index a8d84b18da922491e6dd2996c819899de40ea898..8e31a36bc5ec4d2db51be9265d94bd731c7cb268 100644 (file)
--- a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h
+++ b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h
@@ -37,9 +37,9 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOC
   A function of this type is called when the watchdog timer fires if a \r
   handler has been registered.\r
 \r
   A function of this type is called when the watchdog timer fires if a \r
   handler has been registered.\r
 \r

-  @param  Time The time in 100 ns units that has passed since the watchdog\r
-  timer was armed.  For the notify function to be called, this\r
-  must be greater than TimerPeriod.\r
+  @param  Time             The time in 100 ns units that has passed since the watchdog\r
+                           timer was armed. For the notify function to be called, this\r
+                           must be greater than TimerPeriod.\r

 \r
   @return None.\r
 \r
 \r
   @return None.\r
 \r


@@ -62,19 +62,16 @@ VOID
   If an attempt is made to uninstall a handler when a handler is not installed, \r
   then return EFI_INVALID_PARAMETER.\r
 \r
   If an attempt is made to uninstall a handler when a handler is not installed, \r
   then return EFI_INVALID_PARAMETER.\r
 \r

-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  NotifyFunction The function to call when the watchdog timer fires.  If this\r
-  is NULL, then the handler will be unregistered.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  NotifyFunction   The function to call when the watchdog timer fires. If this\r
+                           is NULL, then the handler will be unregistered.\r

 \r
 \r

-  @retval  EFI_SUCCESS The watchdog timer handler was registered or\r
-  unregistered.\r
-  \r
-  @retval  EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already\r
-  registered.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
-  previously registered.\r
+  @retval EFI_SUCCESS           The watchdog timer handler was registered or\r
+                                unregistered.\r
+  @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already\r
+                                registered.\r
+  @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not\r
+                                previously registered.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -89,17 +86,15 @@ EFI_STATUS
   timer to TimerPeriod 100 nS units.  If TimerPeriod is 0, then the watchdog \r
   timer is disabled.\r
 \r
   timer to TimerPeriod 100 nS units.  If TimerPeriod is 0, then the watchdog \r
   timer is disabled.\r
 \r

-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod The amount of time in 100 nS units to wait before the watchdog\r
-  timer is fired.  If TimerPeriod is zero, then the watchdog\r
-  timer is disabled.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      The amount of time in 100 nS units to wait before the watchdog\r
+                           timer is fired. If TimerPeriod is zero, then the watchdog\r
+                           timer is disabled.\r

 \r
 \r

-  @retval  EFI_SUCCESS The watchdog timer has been programmed to fire in Time\r
-  100 nS units.\r
-  \r
-  @retval  EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device\r
-  error.\r
+  @retval EFI_SUCCESS           The watchdog timer has been programmed to fire in Time\r
+                                100 nS units.\r
+  @retval EFI_DEVICE_ERROR      A watchdog timer could not be programmed due to a device\r
+                                error.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -114,16 +109,14 @@ EFI_STATUS
   the watchdog timer.  This period is returned in TimerPeriod, and EFI_SUCCESS \r
   is returned.  If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.\r
 \r
   the watchdog timer.  This period is returned in TimerPeriod, and EFI_SUCCESS \r
   is returned.  If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.\r
 \r

-  @param  This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
-  \r
-  @param  TimerPeriod A pointer to the amount of time in 100 nS units that the system\r
-  will wait before the watchdog timer is fired.  If TimerPeriod of\r
-  zero is returned, then the watchdog timer is disabled.\r
+  @param  This             The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
+  @param  TimerPeriod      A pointer to the amount of time in 100 nS units that the system\r
+                           will wait before the watchdog timer is fired. If TimerPeriod of\r
+                           zero is returned, then the watchdog timer is disabled.\r

 \r
 \r

-  @retval  EFI_SUCCESS The amount of time that the system will wait before\r
-  firing the watchdog timer was returned in TimerPeriod.\r
-  \r
-  @retval  EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
+  @retval EFI_SUCCESS           The amount of time that the system will wait before\r
+                                firing the watchdog timer was returned in TimerPeriod.\r
+  @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r

 \r
 **/\r
 typedef \r
 \r
 **/\r
 typedef \r


@@ -148,16 +141,16 @@ EFI_STATUS
   been registered, or the registered handler returns, then the system will be \r
   reset by calling the Runtime Service ResetSystem().\r
 \r
   been registered, or the registered handler returns, then the system will be \r
   reset by calling the Runtime Service ResetSystem().\r
 \r

-  @param RegisterHandler - Registers a handler that is invoked when the watchdog \r
-  timer fires.\r
+  @param  RegisterHandler  Registers a handler that is invoked when the watchdog\r
+                           timer fires.\r

 \r
 \r

-  @param SetTimerPeriod  - Sets the amount of time in 100 ns units to wait before the \r
-  watchdog timer is fired.  If this function is supported, \r
-  then the watchdog timer period will be rounded up to the \r
-  nearest supported watchdog timer period.\r
+  @param  SetTimerPeriod   Sets the amount of time in 100 ns units to wait before the\r
+                           watchdog timer is fired. If this function is supported,\r
+                           then the watchdog timer period will be rounded up to the\r
+                           nearest supported watchdog timer period.\r

 \r
 \r

-  @param GetTimerPeriod  - Retrieves the amount of time in 100 ns units that the \r
-  system will wait before the watchdog timer is fired.\r
+  @param  GetTimerPeriod   Retrieves the amount of time in 100 ns units that the\r
+                           system will wait before the watchdog timer is fired.\r

 \r
 **/\r
 struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r
 \r
 **/\r
 struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r