MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Include / Ppi / Stall.h

diff --git a/MdePkg/Include/Ppi/Stall.h b/MdePkg/Include/Ppi/Stall.h
index 2a7e225dc15a562c2bee0ef9102938dd73f1ce65..7139bbba6cff8d302e3d2153e9879008bf188f26 100644 (file)
--- a/MdePkg/Include/Ppi/Stall.h
+++ b/MdePkg/Include/Ppi/Stall.h
@@ -1,20 +1,19 @@
 /** @file\r
   This file declares Stall PPI.\r
 \r
-  This code abstracts the PEI core to provide Stall services.\r
+  This ppi abstracts the blocking stall service to other agents.\r
 \r
-  Copyright (c) 2006 - 2007, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
+  http://opensource.org/licenses/bsd-license.php\r
 \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
+  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
   @par Revision Reference:\r
-  This PPI is defined in PI.\r
-  Version 1.00.\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -27,7 +26,7 @@
 typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;\r
 \r
 /**\r
-  The Stall() function provides a blocking stall for at least the number \r
+  The Stall() function provides a blocking stall for at least the number\r
   of microseconds stipulated in the final argument of the API.\r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table\r
@@ -35,30 +34,26 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;
   @param  This           Pointer to the local data for the interface.\r
   @param  Microseconds   Number of microseconds for which to stall.\r
 \r
-  @retval EFI_SUCCESS           The service provided at least the required delay.\r
+  @retval EFI_SUCCESS    The service provided at least the required delay.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_STALL)(\r
-  IN EFI_PEI_SERVICES           **PeiServices,\r
-  IN EFI_PEI_STALL_PPI          *This,\r
+  IN CONST EFI_PEI_SERVICES     **PeiServices,\r
+  IN CONST EFI_PEI_STALL_PPI    *This,\r
   IN UINTN                      Microseconds\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This service provides a simple, blocking stall with platform-specific resolution. \r
-\r
-  @param Resolution\r
-  The resolution in microseconds of the stall services.\r
-\r
-  @param Stall\r
-  The actual stall procedure call. \r
-\r
-**/\r
+///\r
+/// This service provides a simple, blocking stall with platform-specific resolution.\r
+///\r
 struct _EFI_PEI_STALL_PPI {\r
+  ///\r
+  /// The resolution in microseconds of the stall services.\r
+  ///\r
   UINTN          Resolution;\r
+\r
   EFI_PEI_STALL  Stall;\r
 };\r
 \r