Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index 59e737bd3d5517f63e1a3836ca5644da600881e7..87d077f234342b1f9557d1e99cbf2f53d52608a3 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Driver Diagnostics Protocol\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
@@ -10,16 +10,14 @@
   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:  DriverDiagnostics.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_DRIVER_DIAGNOSTICS_H__\r
 #define __EFI_DRIVER_DIAGNOSTICS_H__\r
 \r
-//\r
-// Global ID for the Driver Diagnostics Protocol as defined in EFI 1.10.\r
-//\r
+///\r
+/// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.\r
+///\r
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
   { \\r
     0x0784924f, 0xe296, 0x11d4, {0x9a, 0x49, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -88,7 +86,7 @@ typedef enum {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS) (\r
+(EFIAPI *EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS)(\r
   IN EFI_DRIVER_DIAGNOSTICS_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                            ControllerHandle,\r
   IN  EFI_HANDLE                                            ChildHandle  OPTIONAL,\r
@@ -99,24 +97,15 @@ EFI_STATUS
   OUT CHAR16                                                **Buffer\r
   );\r
 \r
-\r
-//\r
-//\r
-\r
-/**\r
-  Interface structure for the Driver Diagnostics Protocol.\r
-\r
-  @par Protocol Description:\r
-  Used to perform diagnostics on a controller that an EFI Driver is managing.\r
-\r
-  @param RunDiagnostics      Runs diagnostics on a controller.\r
-  @param SupportedLanguages  A Null-terminated ASCII string that contains one or more\r
-                             ISO 639-2 language codes.  This is the list of language \r
-                             codes that this protocol supports.\r
-\r
-**/\r
+///\r
+/// Used to perform diagnostics on a controller that an EFI Driver is managing.\r
+///\r
 struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL {\r
   EFI_DRIVER_DIAGNOSTICS_RUN_DIAGNOSTICS  RunDiagnostics;\r
+  ///\r
+  /// A Null-terminated ASCII string that contains one or more RFC 3066\r
+  /// language codes.  This is the list of language codes that this protocol supports.  \r
+  ///  \r
   CHAR8                                   *SupportedLanguages;\r
 };\r
 \r