Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index 6c794be50d0efd1e5fdbd332a6b3f50a213614f8..f3683f3304053298364c76d01964719f72789a7b 100644 (file)
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -16,7 +16,7 @@
 #define __EFI_DRIVER_DIAGNOSTICS_H__\r
 \r
 ///\r
-/// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.\r
+/// Global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.\r
 ///\r
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
   { \\r
@@ -26,8 +26,19 @@
 typedef struct _EFI_DRIVER_DIAGNOSTICS_PROTOCOL  EFI_DRIVER_DIAGNOSTICS_PROTOCOL;\r
 \r
 typedef enum {\r
+  ///\r
+  /// Performs standard diagnostics on the controller.\r
+  ///\r
   EfiDriverDiagnosticTypeStandard     = 0,\r
+  ///\r
+  /// This is an optional diagnostic type that performs diagnostics on the controller that may\r
+  /// take an extended amount of time to execute.\r
+  ///\r
   EfiDriverDiagnosticTypeExtended     = 1,\r
+  ///\r
+  /// This is an optional diagnostic type that performs diagnostics on the controller that are\r
+  /// suitable for a manufacturing and test environment.\r
+  ///\r
   EfiDriverDiagnosticTypeManufacturing= 2,\r
   EfiDriverDiagnosticTypeMaximum\r
 } EFI_DRIVER_DIAGNOSTIC_TYPE;\r
@@ -97,24 +108,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