Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics2.h b/MdePkg/Include/Protocol/DriverDiagnostics2.h
index aae0864983b9aa53c858b1c85cb76334df5d646d..a3798b1e543cae51871a133130d3159cd27c9d3b 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics2.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics2.h
@@ -1,7 +1,7 @@
 /** @file\r
-  EFI Driver Diagnostics Protocol\r
+  UEFI Driver Diagnostics2 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
@@ -27,7 +27,7 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
 /**\r
   Runs diagnostics on a controller.\r
 \r
-  @param  This             A pointer to the EFI_DRIVER_DIAGNOSTICS_PROTOCOL instance.\r
+  @param  This             A pointer to the EFI_DRIVER_DIAGNOSTICS2_PROTOCOL instance.\r
   @param  ControllerHandle The handle of the controller to run diagnostics on.\r
   @param  ChildHandle      The handle of the child controller to run diagnostics on\r
                            This is an optional parameter that may be NULL.  It will\r
@@ -38,12 +38,14 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
   @param  DiagnosticType   Indicates type of diagnostics to perform on the controller\r
                            specified by ControllerHandle and ChildHandle.   See\r
                            "Related Definitions" for the list of supported types.\r
-  @param  Language         A pointer to a three character ISO 639-2 language\r
-                           identifier.  This is the language in which the optional\r
-                           error message should be returned in Buffer, and it must\r
-                           match one of the languages specified in SupportedLanguages.\r
-                           The number of languages supported by a driver is up to\r
-                           the driver writer.\r
+  @param  Language         A pointer to a Null-terminated ASCII string\r
+                           array indicating the language. This is the\r
+                           language of the driver name that the caller\r
+                           is requesting, and it must match one of the\r
+                           languages specified in SupportedLanguages.\r
+                           The number of languages supported by a\r
+                           driver is up to the driver writer. Language\r
+                           is specified in RFC 3066 language code format.\r
   @param  ErrorType        A GUID that defines the format of the data returned in Buffer.\r
   @param  BufferSize       The size, in bytes, of the data returned in Buffer.\r
   @param  Buffer           A buffer that contains a Null-terminated Unicode string\r
@@ -89,26 +91,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\r
-                             contains one or more RFC 3066\r
-                             language codes.  This is the list\r
-                             of language codes that this\r
-                             protocol supports.\r
-\r
-**/\r
+///\r
+/// Used to perform diagnostics on a controller that an EFI Driver is managing.\r
+///\r
 struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL {\r
   EFI_DRIVER_DIAGNOSTICS2_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