Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/DriverConfiguration.h b/MdePkg/Include/Protocol/DriverConfiguration.h
index 7c7eca45312b4fffe684486814aaf746979427da..547fd8e557d254d2eb4d21159214ad3e48ca2428 100644 (file)
--- a/MdePkg/Include/Protocol/DriverConfiguration.h
+++ b/MdePkg/Include/Protocol/DriverConfiguration.h
@@ -24,7 +24,6 @@
   { \\r
     0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
   }\r
-\r
  \r
 typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROTOCOL;\r
 \r
@@ -147,30 +146,18 @@ EFI_STATUS
   );\r
 \r
 \r
-/**\r
-  Interface structure for the Driver Configuration Protocol.\r
-\r
-  @par Protocol Description:  \r
-  Used to set configuration options for a controller that an EFI Driver is managing.\r
-\r
-  @param SetOptions          Allows the use to set drivers specific configuration \r
-                             options for a controller that the driver is currently managing.\r
-                             \r
-  @param OptionsValid        Tests to see if a controller's current configuration \r
-                             options are valid. \r
-                             \r
-  @param ForceDefaults       Forces a driver to set the default configuration options \r
-                             for a controller.\r
-\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 set configuration options for a controller that an EFI Driver is managing.\r
+///\r
 struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {\r
   EFI_DRIVER_CONFIGURATION_SET_OPTIONS    SetOptions;\r
   EFI_DRIVER_CONFIGURATION_OPTIONS_VALID  OptionsValid;\r
   EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
+  ///\r
+  /// 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
   CHAR8                                   *SupportedLanguages;\r
 };\r
 \r